@rapidhuman/graph-common 1.0.0

package/dist/uri/uri.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUri = createUri;
+exports.parseUri = parseUri;
+exports.validateUri = validateUri;
+exports.extractSolution = extractSolution;
+exports.extractArtifactType = extractArtifactType;
+const types_1 = require("./types");
+/**
+ * Regex matching the URI format: {project_id}:{solution}:{artifact_type}-{id}
+ *
+ * - project_id: alphanumeric + hyphens, must start with alphanumeric
+ * - solution: one of ideation, transformation, req, arch, spec, platform
+ * - artifact_type: lowercase letters + digits + hyphens, must start with letter
+ * - id: alphanumeric characters
+ */
+const URI_REGEX = /^([a-zA-Z0-9][a-zA-Z0-9-]*):(intel|ideation|transformation|req|arch|spec|code|platform):([a-z][a-z0-9-]*)-([a-zA-Z0-9]+)$/;
+/**
+ * Creates a validated ArtifactUri from its component parts.
+ *
+ * @param projectId - Short project identifier (e.g., "acme")
+ * @param solution - Solution code (ideation, transformation, req, arch, spec, code, platform)
+ * @param artifactType - Artifact type (e.g., "persona", "user-story")
+ * @param id - Unique identifier within the solution
+ * @returns Branded ArtifactUri string
+ * @throws Error if any input is invalid
+ */
+function createUri(projectId, solution, artifactType, id) {
+    if (!projectId || !/^[a-zA-Z0-9][a-zA-Z0-9-]*$/.test(projectId)) {
+        throw new Error(`Invalid projectId "${projectId}": must be alphanumeric with hyphens, starting with alphanumeric`);
+    }
+    if (!types_1.SOLUTION_CODES.includes(solution)) {
+        throw new Error(`Invalid solution "${solution}": must be one of ${types_1.SOLUTION_CODES.join(', ')}`);
+    }
+    if (!artifactType || !/^[a-z][a-z0-9-]*$/.test(artifactType)) {
+        throw new Error(`Invalid artifactType "${artifactType}": must be lowercase alphanumeric with hyphens, starting with a letter`);
+    }
+    if (!id || !/^[a-zA-Z0-9]+$/.test(id)) {
+        throw new Error(`Invalid id "${id}": must be alphanumeric`);
+    }
+    return `${projectId}:${solution}:${artifactType}-${id}`;
+}
+/**
+ * Parses an ArtifactUri string into its component parts.
+ *
+ * @param uri - URI string to parse
+ * @returns ParsedUri with projectId, solution, artifactType, and id
+ * @throws Error if the URI does not match the expected format
+ */
+function parseUri(uri) {
+    const match = URI_REGEX.exec(uri);
+    if (!match) {
+        throw new Error(`Invalid URI "${uri}": expected format {project_id}:{solution}:{artifact_type}-{id}`);
+    }
+    return {
+        projectId: match[1],
+        solution: match[2],
+        artifactType: match[3],
+        id: match[4],
+    };
+}
+/**
+ * Validates a URI string without throwing. Returns a result object
+ * indicating whether the URI is valid, with a descriptive error if not.
+ *
+ * @param uri - URI string to validate
+ * @returns ValidationResult with valid boolean and optional error message
+ */
+function validateUri(uri) {
+    if (!uri) {
+        return { valid: false, error: 'URI is empty' };
+    }
+    const parts = uri.split(':');
+    if (parts.length !== 3) {
+        return {
+            valid: false,
+            error: `URI must have exactly 3 colon-separated parts, found ${parts.length}`,
+        };
+    }
+    const [projectId, solution, typeAndId] = parts;
+    if (!/^[a-zA-Z0-9][a-zA-Z0-9-]*$/.test(projectId)) {
+        return {
+            valid: false,
+            error: `Invalid project_id "${projectId}": must be alphanumeric with hyphens, starting with alphanumeric`,
+        };
+    }
+    if (!types_1.SOLUTION_CODES.includes(solution)) {
+        return {
+            valid: false,
+            error: `Invalid solution "${solution}": must be one of ${types_1.SOLUTION_CODES.join(', ')}`,
+        };
+    }
+    const dashIndex = typeAndId.lastIndexOf('-');
+    if (dashIndex === -1) {
+        return {
+            valid: false,
+            error: `Invalid type-id "${typeAndId}": must contain a hyphen separating artifact_type and id`,
+        };
+    }
+    const artifactType = typeAndId.substring(0, dashIndex);
+    const id = typeAndId.substring(dashIndex + 1);
+    if (!/^[a-z][a-z0-9-]*$/.test(artifactType)) {
+        return {
+            valid: false,
+            error: `Invalid artifact_type "${artifactType}": must be lowercase alphanumeric with hyphens, starting with a letter`,
+        };
+    }
+    if (!id || !/^[a-zA-Z0-9]+$/.test(id)) {
+        return {
+            valid: false,
+            error: `Invalid id "${id}": must be alphanumeric and non-empty`,
+        };
+    }
+    return { valid: true };
+}
+/**
+ * Extracts the solution code from a URI string.
+ *
+ * @param uri - URI string to extract from
+ * @returns SolutionCode
+ * @throws Error if the URI is invalid
+ */
+function extractSolution(uri) {
+    return parseUri(uri).solution;
+}
+/**
+ * Extracts the artifact type from a URI string.
+ *
+ * @param uri - URI string to extract from
+ * @returns ArtifactType
+ * @throws Error if the URI is invalid
+ */
+function extractArtifactType(uri) {
+    return parseUri(uri).artifactType;
+}
+//# sourceMappingURL=uri.js.map

package/dist/uri/uri.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uri.js","sourceRoot":"","sources":["../../src/uri/uri.ts"],"names":[],"mappings":";;AA8BA,8BA+BC;AASD,4BAeC;AASD,kCAuDC;AASD,0CAEC;AASD,kDAEC;AA3KD,mCAQiB;AAEjB;;;;;;;GAOG;AACH,MAAM,SAAS,GAAG,2HAA2H,CAAC;AAE9I;;;;;;;;;GASG;AACH,SAAgB,SAAS,CACvB,SAAoB,EACpB,QAAsB,EACtB,YAA0B,EAC1B,EAAU;IAEV,IAAI,CAAC,SAAS,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAChE,MAAM,IAAI,KAAK,CACb,sBAAsB,SAAS,kEAAkE,CAClG,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,sBAAc,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CACb,qBAAqB,QAAQ,qBAAqB,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC9E,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,YAAY,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QAC7D,MAAM,IAAI,KAAK,CACb,yBAAyB,YAAY,wEAAwE,CAC9G,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CACb,eAAe,EAAE,yBAAyB,CAC3C,CAAC;IACJ,CAAC;IAED,OAAO,GAAG,SAAS,IAAI,QAAQ,IAAI,YAAY,IAAI,EAAE,EAAiB,CAAC;AACzE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,GAAW;IAClC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAElC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CACb,gBAAgB,GAAG,iEAAiE,CACrF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QACnB,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAiB;QAClC,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC;QACtB,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;KACb,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,GAAW;IACrC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC;IACjD,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,wDAAwD,KAAK,CAAC,MAAM,EAAE;SAC9E,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC;IAE/C,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAClD,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,uBAAuB,SAAS,kEAAkE;SAC1G,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,sBAAc,CAAC,QAAQ,CAAC,QAAwB,CAAC,EAAE,CAAC;QACvD,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,qBAAqB,QAAQ,qBAAqB,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SACrF,CAAC;IACJ,CAAC;IAED,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC7C,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,oBAAoB,SAAS,0DAA0D;SAC/F,CAAC;IACJ,CAAC;IAED,MAAM,YAAY,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IACvD,MAAM,EAAE,GAAG,SAAS,CAAC,SAAS,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;IAE9C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QAC5C,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,0BAA0B,YAAY,wEAAwE;SACtH,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACtC,OAAO;YACL,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,eAAe,EAAE,uCAAuC;SAChE,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AACzB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,GAAW;IACzC,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC;AAChC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,GAAW;IAC7C,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC;AACpC,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@rapidhuman/graph-common",
+  "version": "1.0.0",
+  "description": "Shared types, utilities, and interfaces for the Rapidhuman Graph RAG architecture",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "jest",
+    "clean": "rimraf dist"
+  },
+  "keywords": [
+    "rapidhuman",
+    "graph-rag",
+    "spanner"
+  ],
+  "author": "Rapidhuman",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rapidhuman-AI/rapidhuman-graph-common.git"
+  },
+  "peerDependencies": {
+    "@google-cloud/pubsub": "^4.0.0"
+  },
+  "devDependencies": {
+    "@google-cloud/pubsub": "^4.0.0",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^20.0.0",
+    "jest": "^29.7.0",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.4.0"
+  }
+}