@takeshape/util 11.55.0 → 11.58.0

package/dist/common/__tests__/takeshape-id.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/common/__tests__/takeshape-id.test.js

@@ -0,0 +1,26 @@
+import { describe, expect, test } from 'vitest';
+import { extractTakeShapeIDs, parseTakeShapeID } from "../takeshape-id.js";
+describe('parseTakeShapeID', () => {
+    test('simple example', () => {
+        expect(parseTakeShapeID('tid:rick:Character:1')).toEqual({
+            service: 'rick',
+            shapeName: 'Character',
+            id: '1'
+        });
+    });
+    test('colon in the id is allowed', () => {
+        expect(parseTakeShapeID('tid:shopify:Product:gid://shopify/Product/12345')).toEqual({
+            service: 'shopify',
+            shapeName: 'Product',
+            id: 'gid://shopify/Product/12345'
+        });
+    });
+});
+describe('extractTakeShapeIDs', () => {
+    test('simple example', () => {
+        expect(extractTakeShapeIDs('Here is a cool character:\n\ntid:rick:Character:1\n\nAnd another is tid:rick:Character:2')).toEqual(['tid:rick:Character:1', 'tid:rick:Character:2']);
+    });
+    test('colons in the id part are allowed', () => {
+        expect(extractTakeShapeIDs('Here is a nice product: tid:shopify:Product:gid://shopify/Product/12345\n\nHope you like it')).toEqual(['tid:shopify:Product:gid://shopify/Product/12345']);
+    });
+});

package/dist/common/index.d.ts

@@ -33,3 +33,4 @@ export * from './validation.ts';
 export * from './value.ts';
 export * from './visit.ts';
 export * from './empty.ts';
+export * from './takeshape-id.ts';

package/dist/common/index.js

@@ -33,3 +33,4 @@ export * from "./validation.js";
 export * from "./value.js";
 export * from "./visit.js";
 export * from "./empty.js";
+export * from "./takeshape-id.js";

package/dist/common/takeshape-id.d.ts

@@ -0,0 +1,11 @@
+/**
+ * AKA TID. A unique ID that refers to an object in the TakeShape data index.
+ */
+export type TakeShapeID = `tid:${string}`;
+export type ParsedTakeshapeID = {
+    service: string;
+    shapeName: string;
+    id: string;
+};
+export declare const parseTakeShapeID: (tid: string) => ParsedTakeshapeID;
+export declare const extractTakeShapeIDs: (input: string) => TakeShapeID[];

package/dist/common/takeshape-id.js

@@ -0,0 +1,25 @@
+/**
+ * Pattern to match a TakeShapeID. Note that colons are allowed in the ID part of the TID.
+ * For example, `tid:rick:Character:gid://foo` is valid and the ID part is `gid://foo`.
+ */
+const TID_REGEX = /\btid:([^:\s]+):([^:\s]+):([^\s]+)/g;
+export const parseTakeShapeID = (tid) => {
+    const [prefix, service, shapeName, ...rest] = tid.split(':');
+    if (prefix !== 'tid') {
+        throw new Error(`Invalid TID: ${tid}`);
+    }
+    return {
+        service,
+        shapeName,
+        id: rest.join(':')
+    };
+};
+export const extractTakeShapeIDs = (input) => {
+    const matches = [];
+    let match = TID_REGEX.exec(input);
+    while (match !== null) {
+        matches.push(match[0]);
+        match = TID_REGEX.exec(input);
+    }
+    return matches;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@takeshape/util",
-  "version": "11.55.0",
+  "version": "11.58.0",
   "description": "Shared utilities",
   "homepage": "https://www.takeshape.io",
   "repository": {
@@ -46,7 +46,7 @@
     "tiny-invariant": "^1.2.0",
     "uint8array-extras": "^1.4.0",
     "url-parse": "^1.5.3",
-    "@takeshape/routing": "11.55.0"
+    "@takeshape/routing": "11.58.0"
   },
   "devDependencies": {
     "@types/classnames": "^2.2.9",
@@ -67,12 +67,11 @@
     "prebuild:ci": "pnpm clean",
     "build:ci": "pnpm build --noCheck",
     "clean": "del-cli dist coverage *.tsbuildinfo",
-    "lint": "pnpm lint:biome && pnpm lint:eslint",
+    "lint": "trap 'RC=1' ERR; pnpm lint:biome; pnpm lint:eslint; exit $RC",
     "lint:biome": "biome check",
     "lint:eslint": "eslint src -c ../../eslint.config.mjs",
-    "lint:ci": "pnpm lint:ci:biome; pnpm lint:ci:eslint",
     "lint:ci:biome": "mkdir -p \"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}\" && biome check --diagnostic-level error --reporter=junit > \"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}/biome-results.xml\"",
-    "lint:ci:eslint": "pnpm lint:eslint --quiet --format json -o \"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}/eslint-results.json\"",
+    "lint:ci:eslint": "ESLINT_SUITE_NAME=${npm_package_name} ESLINT_JUNIT_OUTPUT=\"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}/eslint-results.xml\" pnpm lint:eslint --quiet --format ../../node_modules/eslint-junit/index.js",
     "test": "TZ=UTC vitest run",
     "test:ci": "TZ=UTC vitest run --reporter=default --reporter=junit --outputFile=\"${GITHUB_WORKSPACE}/test-results/${npm_package_name#*\\/}/vitest-results.xml\" --coverage.enabled --coverage.reportsDirectory=\"${GITHUB_WORKSPACE}/coverage/${npm_package_name#*\\/}\"",
     "todo": "leasot 'src/**/*.{js,jsx,ts,tsx}'",