feat: add typegen support for string slice (#1468)

.changeset/fast-forks-lie.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/abi-typegen": minor
+---
+
+add string slice support in typegen

apps/docs-snippets/test/fixtures/forc-projects/echo-values/src/main.sw

@@ -8,6 +8,8 @@ abi EchoValues {
 
     fn echo_str_8(value: str[8]) -> str[8];
 
+    fn echo_str(value: str) -> str;
+
     fn echo_tuple(tuple: (u8, bool, u64)) -> (u8, bool, u64);
 
     fn echo_b512(input: B512) -> B512;
@@ -18,6 +20,15 @@ impl EchoValues for Contract {
         value
     }
 
+    // Avoid executing this function; it is currently unsupported.
+    // Refer to: https://github.com/FuelLabs/sway/issues/5110 for more details.
+    // The function is defined here to include the type 'str' in the ABI,
+    // ensuring Typegen can accurately interpret it.
+    // For further information, see: https://github.com/FuelLabs/fuels-ts/issues/1469
+    fn echo_str(value: str) -> str {
+        value
+    }
+
     fn echo_str_8(value: str[8]) -> str[8] {
         value
     }

packages/abi-typegen/src/abi/types/StrSliceType.ts

@@ -0,0 +1,23 @@
+import type { IType } from '../../types/interfaces/IType';
+
+import { AType } from './AType';
+
+export class StrSliceType extends AType implements IType {
+  public static swayType = 'str';
+
+  public name = 'strSlice';
+
+  static MATCH_REGEX: RegExp = /^str$/m;
+
+  static isSuitableFor(params: { type: string }) {
+    return StrSliceType.MATCH_REGEX.test(params.type);
+  }
+
+  public parseComponentsAttributes(_params: { types: IType[] }) {
+    this.attributes = {
+      inputLabel: 'StrSlice',
+      outputLabel: 'StrSlice',
+    };
+    return this.attributes;
+  }
+}

packages/abi-typegen/src/abi/types/StrSlicesType.test.ts

@@ -0,0 +1,33 @@
+import { BoolType } from './BoolType';
+import { StdStringType } from './StdStringType';
+import { StrSliceType } from './StrSliceType';
+import { StrType } from './StrType';
+
+describe('StrSlicesType.ts', () => {
+  test('should properly parse type attributes', () => {
+    const strSlices = new StrSliceType({
+      rawAbiType: {
+        components: null,
+        typeParameters: null,
+        typeId: 1,
+        type: StrSliceType.swayType,
+      },
+    });
+
+    strSlices.parseComponentsAttributes({ types: [] });
+
+    const suitableForStrSlices = StrSliceType.isSuitableFor({ type: StrSliceType.swayType });
+    const suitableForU16 = StrSliceType.isSuitableFor({ type: BoolType.swayType });
+    const suitableForStr = StrSliceType.isSuitableFor({ type: StrType.swayType });
+    const suitableForStdString = StrSliceType.isSuitableFor({ type: StdStringType.swayType });
+
+    expect(suitableForStrSlices).toEqual(true);
+    expect(suitableForU16).toEqual(false);
+    expect(suitableForStr).toEqual(false);
+    expect(suitableForStdString).toEqual(false);
+
+    expect(strSlices.attributes.inputLabel).toEqual('StrSlice');
+    expect(strSlices.attributes.outputLabel).toEqual('StrSlice');
+    expect(strSlices.requiredFuelsMembersImports).toStrictEqual([]);
+  });
+});

packages/abi-typegen/src/utils/supportedTypes.test.ts

@@ -2,6 +2,6 @@ import { supportedTypes } from './supportedTypes';
 
 describe('supportedTypes.ts', () => {
   test('should export all supported types', () => {
-    expect(supportedTypes.length).toEqual(20);
+    expect(supportedTypes.length).toEqual(21);
   });
 });

packages/abi-typegen/src/utils/supportedTypes.ts

@@ -10,6 +10,7 @@ import { OptionType } from '../abi/types/OptionType';
 import { RawUntypedPtr } from '../abi/types/RawUntypedPtr';
 import { RawUntypedSlice } from '../abi/types/RawUntypedSlice';
 import { StdStringType } from '../abi/types/StdStringType';
+import { StrSliceType } from '../abi/types/StrSliceType';
 import { StrType } from '../abi/types/StrType';
 import { StructType } from '../abi/types/StructType';
 import { TupleType } from '../abi/types/TupleType';
@@ -32,6 +33,7 @@ export const supportedTypes = [
   RawUntypedSlice,
   StdStringType,
   StrType,
+  StrSliceType,
   StructType,
   TupleType,
   U16Type,