@hyperlane-xyz/utils 0.0.0-beta-20251201221151

package/dist/eslint-rules/sort-yaml-arrays.test.js

@@ -0,0 +1,621 @@
+import { expect } from 'chai';
+import rule from './sort-yaml-arrays.js';
+describe('sort-yaml-arrays rule', () => {
+    let lintResult;
+    let fixer;
+    beforeEach(() => {
+        lintResult = null;
+        // Only implement replaceText since it's the only method actually used
+        const dummyFix = () => ({
+            range: [0, 0],
+            text: '',
+        });
+        fixer = {
+            replaceText: (_, text) => {
+                lintResult = { fixed: true, output: text };
+                return { range: [0, 0], text };
+            },
+            insertTextAfter: dummyFix,
+            insertTextAfterRange: dummyFix,
+            insertTextBefore: dummyFix,
+            insertTextBeforeRange: dummyFix,
+            remove: dummyFix,
+            removeRange: dummyFix,
+            replaceTextRange: dummyFix,
+        };
+    });
+    function runLint(yamlText, filename, options = {}) {
+        const context = {
+            id: 'sort-yaml-arrays',
+            options: [options],
+            filename,
+            sourceCode: {
+                getText: () => yamlText,
+            },
+            report: ({ fix }) => {
+                if (fix)
+                    fix(fixer);
+            },
+        };
+        const ruleInstance = rule.create(context);
+        if (ruleInstance?.Program) {
+            const lineCount = yamlText.split('\n').length;
+            ruleInstance.Program({
+                parent: {},
+                sourceType: 'module',
+                type: 'Program',
+                body: [],
+                range: [0, yamlText.length],
+                loc: {
+                    start: { line: 1, column: 0 },
+                    end: { line: lineCount, column: 0 },
+                },
+            });
+        }
+        return lintResult;
+    }
+    const testCases = [
+        {
+            name: 'should sort people by name',
+            original: `people:
+  - name: Charlie
+    age: 30
+  - name: Alice
+    age: 25
+  - name: Bob
+    age: 35`,
+            expected: `people:
+  - name: Alice
+    age: 25
+  - name: Bob
+    age: 35
+  - name: Charlie
+    age: 30`,
+            options: {
+                arrays: [{ path: 'people', sortKey: 'name' }],
+            },
+        },
+        {
+            name: 'should sort people by age',
+            original: `people:
+  - name: Charlie
+    age: 30
+  - name: Alice
+    age: 25
+  - name: Bob
+    age: 35`,
+            expected: `people:
+  - name: Alice
+    age: 25
+  - name: Charlie
+    age: 30
+  - name: Bob
+    age: 35`,
+            options: {
+                arrays: [{ path: 'people', sortKey: 'age' }],
+            },
+        },
+        {
+            name: 'should sort nested arrays',
+            original: `departments:
+  - name: Engineering
+    employees:
+      - name: Dave
+        position: Developer
+      - name: Alice
+        position: Manager
+  - name: Marketing
+    employees:
+      - name: Zack
+        position: Designer
+      - name: Bob
+        position: Director`,
+            expected: `departments:
+  - name: Engineering
+    employees:
+      - name: Alice
+        position: Manager
+      - name: Dave
+        position: Developer
+  - name: Marketing
+    employees:
+      - name: Bob
+        position: Director
+      - name: Zack
+        position: Designer`,
+            options: {
+                arrays: [{ path: 'departments[].employees', sortKey: 'name' }],
+            },
+        },
+        {
+            name: 'should sort multiple arrays with different keys',
+            original: `company:
+  departments:
+    - id: 3
+      name: Engineering
+      projects:
+        - priority: 2
+          name: Website
+        - priority: 1
+          name: API
+    - id: 1
+      name: Marketing
+      projects:
+        - priority: 3
+          name: Campaign
+        - priority: 1
+          name: Branding`,
+            expected: `company:
+  departments:
+    - id: 1
+      name: Marketing
+      projects:
+        - priority: 1
+          name: Branding
+        - priority: 3
+          name: Campaign
+    - id: 3
+      name: Engineering
+      projects:
+        - priority: 1
+          name: API
+        - priority: 2
+          name: Website`,
+            options: {
+                arrays: [
+                    { path: 'company.departments', sortKey: 'id' },
+                    { path: 'company.departments.*.projects', sortKey: 'priority' },
+                ],
+            },
+        },
+        {
+            name: 'should preserve comments',
+            original: `# This is a top comment
+people:
+  # First person
+  - name: Charlie
+    age: 30
+  # Second person 
+  - name: Alice
+    age: 25
+  # Third person
+  - name: Bob
+    age: 35`,
+            expected: `# This is a top comment
+people:
+  # Second person 
+  - name: Alice
+    age: 25
+  # Third person
+  - name: Bob
+    age: 35
+  # First person
+  - name: Charlie
+    age: 30`,
+            options: {
+                arrays: [{ path: 'people', sortKey: 'name' }],
+            },
+        },
+        {
+            name: 'should sort arrays with numeric values',
+            original: `versions:
+  - version: 1.2.0
+    released: true
+  - version: 0.9.0
+    released: true
+  - version: 2.0.0
+    released: false`,
+            expected: `versions:
+  - version: 0.9.0
+    released: true
+  - version: 1.2.0
+    released: true
+  - version: 2.0.0
+    released: false`,
+            options: {
+                arrays: [{ path: 'versions', sortKey: 'version' }],
+            },
+        },
+        {
+            name: 'should sort arrays with boolean values',
+            original: `features:
+  - name: auth
+    enabled: true
+  - name: notifications
+    enabled: true
+  - name: search
+    enabled: false`,
+            expected: `features:
+  - name: search
+    enabled: false
+  - name: auth
+    enabled: true
+  - name: notifications
+    enabled: true`,
+            options: {
+                arrays: [{ path: 'features', sortKey: 'enabled' }],
+            },
+        },
+        {
+            name: 'should handle deeply nested structures',
+            original: `organization:
+  divisions:
+    americas:
+      regions:
+        - code: US-W
+          name: West
+          offices:
+            - city: Portland
+              employees: 120
+            - city: Seattle
+              employees: 200
+            - city: San Francisco
+              employees: 300
+        - code: US-E
+          name: East
+          offices:
+            - city: New York
+              employees: 450
+            - city: Boston
+              employees: 150`,
+            expected: `organization:
+  divisions:
+    americas:
+      regions:
+        - code: US-W
+          name: West
+          offices:
+            - city: Portland
+              employees: 120
+            - city: Seattle
+              employees: 200
+            - city: San Francisco
+              employees: 300
+        - code: US-E
+          name: East
+          offices:
+            - city: Boston
+              employees: 150
+            - city: New York
+              employees: 450`,
+            options: {
+                arrays: [
+                    {
+                        path: 'organization.divisions.americas.regions.*.offices',
+                        sortKey: 'employees',
+                    },
+                ],
+            },
+        },
+        {
+            name: 'should handle arrays without the sort key',
+            original: `items:
+  - id: 3
+    name: Hammer
+  - name: Screwdriver
+  - id: 1
+    name: Wrench
+  - id: 2`,
+            expected: `items:
+  - id: 1
+    name: Wrench
+  - id: 2
+  - id: 3
+    name: Hammer
+  - name: Screwdriver`,
+            options: {
+                arrays: [{ path: 'items', sortKey: 'id' }],
+            },
+        },
+        {
+            name: 'should preserve inline comments when sorting',
+            original: `configs:
+  - name: production # Production environment
+    priority: 3
+    active: true
+  - name: staging # Staging environment
+    priority: 2
+    active: true
+  - name: development # Development environment
+    priority: 1
+    active: false`,
+            expected: `configs:
+  - name: development # Development environment
+    priority: 1
+    active: false
+  - name: staging # Staging environment
+    priority: 2
+    active: true
+  - name: production # Production environment
+    priority: 3
+    active: true`,
+            options: {
+                arrays: [{ path: 'configs', sortKey: 'priority' }],
+            },
+        },
+        {
+            name: 'should preserve multi-line comments between items',
+            original: `services:
+  # Database service
+  # Handles all data storage
+  - name: db
+    port: 5432
+  # API service
+  # Handles external requests
+  - name: api
+    port: 3000
+  # Web service
+  # Serves the frontend
+  - name: web
+    port: 8080`,
+            expected: `services:
+  # API service
+  # Handles external requests
+  - name: api
+    port: 3000
+  # Database service
+  # Handles all data storage
+  - name: db
+    port: 5432
+  # Web service
+  # Serves the frontend
+  - name: web
+    port: 8080`,
+            options: {
+                arrays: [{ path: 'services', sortKey: 'name' }],
+            },
+        },
+        {
+            name: 'should handle array indexing with [] in path',
+            original: `data:
+  - list:
+      - value: 3
+      - value: 1
+  - list:
+      - value: 5
+      - value: 2`,
+            expected: `data:
+  - list:
+      - value: 1
+      - value: 3
+  - list:
+      - value: 2
+      - value: 5`,
+            options: {
+                arrays: [{ path: 'data[].list', sortKey: 'value' }],
+            },
+        },
+        {
+            name: 'should handle wildcard at beginning of path',
+            original: `store:
+  products:
+    - name: Laptop
+      price: 1200
+    - name: Phone
+      price: 800
+  services:
+    - name: Repair
+      price: 150
+    - name: Installation
+      price: 50`,
+            expected: `store:
+  products:
+    - name: Phone
+      price: 800
+    - name: Laptop
+      price: 1200
+  services:
+    - name: Installation
+      price: 50
+    - name: Repair
+      price: 150`,
+            options: {
+                arrays: [
+                    { path: '*.products', sortKey: 'price' },
+                    { path: '*.services', sortKey: 'price' },
+                ],
+            },
+        },
+        {
+            name: 'should handle multiple wildcards in path',
+            original: `departments:
+  engineering:
+    teams:
+      frontend:
+        members:
+          - name: Dave
+            level: 3
+          - name: Alice
+            level: 5
+      backend:
+        members:
+          - name: Bob
+            level: 4
+          - name: Carol
+            level: 2
+  design:
+    teams:
+      ux:
+        members:
+          - name: Eve
+            level: 3
+          - name: Frank
+            level: 1`,
+            expected: `departments:
+  engineering:
+    teams:
+      frontend:
+        members:
+          - name: Dave
+            level: 3
+          - name: Alice
+            level: 5
+      backend:
+        members:
+          - name: Carol
+            level: 2
+          - name: Bob
+            level: 4
+  design:
+    teams:
+      ux:
+        members:
+          - name: Frank
+            level: 1
+          - name: Eve
+            level: 3`,
+            options: {
+                arrays: [{ path: 'departments.*.teams.*.members', sortKey: 'level' }],
+            },
+        },
+        {
+            name: 'should handle array notation with number indexes',
+            original: `data:
+  - id: 1
+    items:
+      - order: B
+        quantity: 5
+      - order: A
+        quantity: 10
+  - id: 2
+    items:
+      - order: D
+        quantity: 2
+      - order: C
+        quantity: 8`,
+            expected: `data:
+  - id: 1
+    items:
+      - order: A
+        quantity: 10
+      - order: B
+        quantity: 5
+  - id: 2
+    items:
+      - order: C
+        quantity: 8
+      - order: D
+        quantity: 2`,
+            options: {
+                arrays: [{ path: 'data[].items', sortKey: 'order' }],
+            },
+        },
+        {
+            name: 'should handle complex path with array notation and wildcards',
+            original: `repositories:
+  - name: frontend
+    branches:
+      main:
+        commits:
+          - hash: abc123
+            priority: 3
+          - hash: def456
+            priority: 1
+      develop:
+        commits:
+          - hash: ghi789
+            priority: 2
+          - hash: jkl012
+            priority: 4
+  - name: backend
+    branches:
+      main:
+        commits:
+          - hash: mno345
+            priority: 5
+          - hash: pqr678
+            priority: 2
+      staging:
+        commits:
+          - hash: stu901
+            priority: 1
+          - hash: vwx234
+            priority: 3`,
+            expected: `repositories:
+  - name: frontend
+    branches:
+      main:
+        commits:
+          - hash: def456
+            priority: 1
+          - hash: abc123
+            priority: 3
+      develop:
+        commits:
+          - hash: ghi789
+            priority: 2
+          - hash: jkl012
+            priority: 4
+  - name: backend
+    branches:
+      main:
+        commits:
+          - hash: pqr678
+            priority: 2
+          - hash: mno345
+            priority: 5
+      staging:
+        commits:
+          - hash: stu901
+            priority: 1
+          - hash: vwx234
+            priority: 3`,
+            options: {
+                arrays: [
+                    { path: 'repositories[].branches.*.commits', sortKey: 'priority' },
+                ],
+            },
+        },
+        {
+            name: 'should handle missing sort keys by placing them at the end',
+            original: `projects:
+  - name: Alpha
+    priority: 2
+    status: active
+  - name: Beta
+    status: pending
+  - name: Gamma
+    priority: 1
+    status: active
+  - name: Delta
+    priority: 3
+    status: inactive
+  - name: Epsilon
+    status: active`,
+            expected: `projects:
+  - name: Gamma
+    priority: 1
+    status: active
+  - name: Alpha
+    priority: 2
+    status: active
+  - name: Delta
+    priority: 3
+    status: inactive
+  - name: Beta
+    status: pending
+  - name: Epsilon
+    status: active`,
+            options: {
+                arrays: [{ path: 'projects', sortKey: 'priority' }],
+            },
+        },
+    ];
+    testCases.forEach(({ name, original, expected, options = { arrays: [] } }) => {
+        it(name, () => {
+            const result = runLint(original, 'test.yaml', options);
+            if (result) {
+                expect(result.fixed).to.be.true;
+                expect(result.output).to.equal(expected);
+            }
+            else {
+                expect(original).to.equal(expected);
+            }
+        });
+    });
+    it('should ignore non-YAML files', () => {
+        const result = runLint(`const data = { name: 'test' };`, 'test.js');
+        expect(result).to.be.null;
+    });
+});
+//# sourceMappingURL=sort-yaml-arrays.test.js.map

package/dist/eslint-rules/sort-yaml-arrays.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-yaml-arrays.test.js","sourceRoot":"","sources":["../../src/eslint-rules/sort-yaml-arrays.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAG9B,OAAO,IAAI,MAAM,uBAAuB,CAAC;AAWzC,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,IAAI,UAAqD,CAAC;IAC1D,IAAI,KAAqB,CAAC;IAE1B,UAAU,CAAC,GAAG,EAAE;QACd,UAAU,GAAG,IAAI,CAAC;QAElB,sEAAsE;QACtE,MAAM,QAAQ,GAAmB,GAAG,EAAE,CAAC,CAAC;YACtC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAqB;YACjC,IAAI,EAAE,EAAE;SACT,CAAC,CAAC;QAEH,KAAK,GAAG;YACN,WAAW,EAAE,CAAC,CAAC,EAAE,IAAY,EAAE,EAAE;gBAC/B,UAAU,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;gBAC3C,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAqB,EAAE,IAAI,EAAE,CAAC;YACrD,CAAC;YACD,eAAe,EAAE,QAAQ;YACzB,oBAAoB,EAAE,QAAQ;YAC9B,gBAAgB,EAAE,QAAQ;YAC1B,qBAAqB,EAAE,QAAQ;YAC/B,MAAM,EAAE,QAAQ;YAChB,WAAW,EAAE,QAAQ;YACrB,gBAAgB,EAAE,QAAQ;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,SAAS,OAAO,CACd,QAAgB,EAChB,QAAgB,EAChB,UAA+B,EAAE;QAEjC,MAAM,OAAO,GAAG;YACd,EAAE,EAAE,kBAAkB;YACtB,OAAO,EAAE,CAAC,OAAO,CAAC;YAClB,QAAQ;YACR,UAAU,EAAE;gBACV,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ;aACxB;YACD,MAAM,EAAE,CAAC,EAAE,GAAG,EAAgD,EAAE,EAAE;gBAChE,IAAI,GAAG;oBAAE,GAAG,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;SAC6B,CAAC;QAEjC,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE1C,IAAI,YAAY,EAAE,OAAO,EAAE,CAAC;YAC1B,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;YAC9C,YAAY,CAAC,OAAO,CAAC;gBACnB,MAAM,EAAE,EAAS;gBACjB,UAAU,EAAE,QAAQ;gBACpB,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,EAAE;gBACR,KAAK,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC;gBAC3B,GAAG,EAAE;oBACH,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;oBAC7B,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE;iBACpC;aACF,CAAC,CAAC;QACL,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,MAAM,SAAS,GAAe;QAC5B;YACE,IAAI,EAAE,4BAA4B;YAClC,QAAQ,EAAE;;;;;;YAMJ;YACN,QAAQ,EAAE;;;;;;YAMJ;YACN,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;aAC9C;SACF;QACD;YACE,IAAI,EAAE,2BAA2B;YACjC,QAAQ,EAAE;;;;;;YAMJ;YACN,QAAQ,EAAE;;;;;;YAMJ;YACN,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;aAC7C;SACF;QACD;YACE,IAAI,EAAE,2BAA2B;YACjC,QAAQ,EAAE;;;;;;;;;;;;2BAYW;YACrB,QAAQ,EAAE;;;;;;;;;;;;2BAYW;YACrB,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;aAC/D;SACF;QACD;YACE,IAAI,EAAE,iDAAiD;YACvD,QAAQ,EAAE;;;;;;;;;;;;;;;yBAeS;YACnB,QAAQ,EAAE;;;;;;;;;;;;;;;wBAeQ;YAClB,OAAO,EAAE;gBACP,MAAM,EAAE;oBACN,EAAE,IAAI,EAAE,qBAAqB,EAAE,OAAO,EAAE,IAAI,EAAE;oBAC9C,EAAE,IAAI,EAAE,gCAAgC,EAAE,OAAO,EAAE,UAAU,EAAE;iBAChE;aACF;SACF;QACD;YACE,IAAI,EAAE,0BAA0B;YAChC,QAAQ,EAAE;;;;;;;;;;YAUJ;YACN,QAAQ,EAAE;;;;;;;;;;YAUJ;YACN,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;aAC9C;SACF;QACD;YACE,IAAI,EAAE,wCAAwC;YAC9C,QAAQ,EAAE;;;;;;oBAMI;YACd,QAAQ,EAAE;;;;;;oBAMI;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;aACnD;SACF;QACD;YACE,IAAI,EAAE,wCAAwC;YAC9C,QAAQ,EAAE;;;;;;mBAMG;YACb,QAAQ,EAAE;;;;;;kBAME;YACZ,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;aACnD;SACF;QACD;YACE,IAAI,EAAE,wCAAwC;YAC9C,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;6BAmBa;YACvB,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;6BAmBa;YACvB,OAAO,EAAE;gBACP,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,mDAAmD;wBACzD,OAAO,EAAE,WAAW;qBACrB;iBACF;aACF;SACF;QACD;YACE,IAAI,EAAE,2CAA2C;YACjD,QAAQ,EAAE;;;;;;UAMN;YACJ,QAAQ,EAAE;;;;;;sBAMM;YAChB,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;aAC3C;SACF;QACD;YACE,IAAI,EAAE,8CAA8C;YACpD,QAAQ,EAAE;;;;;;;;;kBASE;YACZ,QAAQ,EAAE;;;;;;;;;iBASC;YACX,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;aACnD;SACF;QACD;YACE,IAAI,EAAE,mDAAmD;YACzD,QAAQ,EAAE;;;;;;;;;;;;eAYD;YACT,QAAQ,EAAE;;;;;;;;;;;;eAYD;YACT,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;aAChD;SACF;QACD;YACE,IAAI,EAAE,8CAA8C;YACpD,QAAQ,EAAE;;;;;;iBAMC;YACX,QAAQ,EAAE;;;;;;iBAMC;YACX,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;aACpD;SACF;QACD;YACE,IAAI,EAAE,6CAA6C;YACnD,QAAQ,EAAE;;;;;;;;;;gBAUA;YACV,QAAQ,EAAE;;;;;;;;;;iBAUC;YACX,OAAO,EAAE;gBACP,MAAM,EAAE;oBACN,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE;oBACxC,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE;iBACzC;aACF;SACF;QACD;YACE,IAAI,EAAE,0CAA0C;YAChD,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;;;;qBAsBK;YACf,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;;;;qBAsBK;YACf,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,+BAA+B,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;aACtE;SACF;QACD;YACE,IAAI,EAAE,kDAAkD;YACxD,QAAQ,EAAE;;;;;;;;;;;;oBAYI;YACd,QAAQ,EAAE;;;;;;;;;;;;oBAYI;YACd,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;aACrD;SACF;QACD;YACE,IAAI,EAAE,8DAA8D;YACpE,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA4BQ;YAClB,QAAQ,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBA4BQ;YAClB,OAAO,EAAE;gBACP,MAAM,EAAE;oBACN,EAAE,IAAI,EAAE,mCAAmC,EAAE,OAAO,EAAE,UAAU,EAAE;iBACnE;aACF;SACF;QACD;YACE,IAAI,EAAE,4DAA4D;YAClE,QAAQ,EAAE;;;;;;;;;;;;;mBAaG;YACb,QAAQ,EAAE;;;;;;;;;;;;;mBAaG;YACb,OAAO,EAAE;gBACP,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;aACpD;SACF;KACF,CAAC;IAEF,SAAS,CAAC,OAAO,CACf,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;QACzD,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE;YACZ,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;YAEvD,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;gBAChC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CACF,CAAC;IAEF,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,MAAM,GAAG,OAAO,CAAC,gCAAgC,EAAE,SAAS,CAAC,CAAC;QACpE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IAC5B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/ids.d.ts

@@ -0,0 +1,20 @@
+import { BytesLike } from 'ethers';
+/**
+ * Converts a 20-byte (or other length) ID to a 32-byte ID.
+ * Ensures that a bytes-like is 32 long. left-padding with 0s if not.
+ *
+ * @param data A string or array of bytes to canonize
+ * @returns A Uint8Array of length 32
+ */
+export declare function canonizeId(data: BytesLike): Uint8Array;
+/**
+ * Converts a Hyperlane ID of 20 or 32 bytes to the corresponding EVM Address.
+ *
+ * For 32-byte IDs this enforces the EVM convention of using the LAST 20 bytes.
+ *
+ * @param data The data to truncate
+ * @returns A 20-byte, 0x-prepended hex string representing the EVM Address
+ * @throws if the data is not 20 or 32 bytes
+ */
+export declare function evmId(data: BytesLike): string;
+//# sourceMappingURL=ids.d.ts.map

package/dist/ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../src/ids.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAS,MAAM,QAAQ,CAAC;AAE1C;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,UAAU,CAUtD;AAED;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAU7C"}

package/dist/ids.js

@@ -0,0 +1,42 @@
+import { utils } from 'ethers';
+/**
+ * Converts a 20-byte (or other length) ID to a 32-byte ID.
+ * Ensures that a bytes-like is 32 long. left-padding with 0s if not.
+ *
+ * @param data A string or array of bytes to canonize
+ * @returns A Uint8Array of length 32
+ */
+export function canonizeId(data) {
+    if (!data)
+        throw new Error('Bad input. Undefined');
+    const buf = utils.arrayify(data);
+    if (buf.length > 32) {
+        throw new Error('Too long');
+    }
+    if (buf.length !== 20 && buf.length != 32) {
+        throw new Error('bad input, expect address or bytes32');
+    }
+    return utils.zeroPad(buf, 32);
+}
+/**
+ * Converts a Hyperlane ID of 20 or 32 bytes to the corresponding EVM Address.
+ *
+ * For 32-byte IDs this enforces the EVM convention of using the LAST 20 bytes.
+ *
+ * @param data The data to truncate
+ * @returns A 20-byte, 0x-prepended hex string representing the EVM Address
+ * @throws if the data is not 20 or 32 bytes
+ */
+export function evmId(data) {
+    const u8a = utils.arrayify(data);
+    if (u8a.length === 32) {
+        return utils.hexlify(u8a.slice(12, 32));
+    }
+    else if (u8a.length === 20) {
+        return utils.hexlify(u8a);
+    }
+    else {
+        throw new Error(`Invalid id length. expected 20 or 32. Got ${u8a.length}`);
+    }
+}
+//# sourceMappingURL=ids.js.map

package/dist/ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.js","sourceRoot":"","sources":["../src/ids.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,IAAe;IACxC,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACnD,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,GAAG,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,KAAK,EAAE,IAAI,GAAG,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,KAAK,CAAC,IAAe;IACnC,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEjC,IAAI,GAAG,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1C,CAAC;SAAM,IAAI,GAAG,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,6CAA6C,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC"}

package/dist/ids.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ids.test.d.ts.map

package/dist/ids.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.test.d.ts","sourceRoot":"","sources":["../src/ids.test.ts"],"names":[],"mappings":""}