@globaltypesystem/gts-ts 0.1.0

package/dist/extract.js

@@ -0,0 +1,194 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GtsExtractor = void 0;
+exports.getDefaultConfig = getDefaultConfig;
+const types_1 = require("./types");
+const gts_1 = require("./gts");
+function getDefaultConfig() {
+    return {
+        entityIdFields: ['$id', '$$id', 'gtsId', 'gtsIid', 'gtsOid', 'gtsI', 'gts_id', 'gts_oid', 'gts_iid', 'id'],
+        schemaIdFields: [
+            '$schema',
+            '$$schema',
+            'gtsTid',
+            'gtsType',
+            'gtsT',
+            'gts_t',
+            'gts_tid',
+            'gts_type',
+            'type',
+            'schema',
+        ],
+    };
+}
+class GtsExtractor {
+    static normalizeValue(value, fieldName) {
+        let normalized = value.trim();
+        // Strip the "gts://" URI prefix for $id field (JSON Schema compatibility)
+        if (fieldName === '$id' && normalized.startsWith(types_1.GTS_URI_PREFIX)) {
+            normalized = normalized.substring(types_1.GTS_URI_PREFIX.length);
+        }
+        else if (normalized.startsWith(types_1.GTS_URI_PREFIX)) {
+            normalized = normalized.substring(types_1.GTS_URI_PREFIX.length);
+        }
+        return normalized;
+    }
+    static findFirstValidField(content, fields, requireValid = false) {
+        if (typeof content !== 'object' || content === null) {
+            return null;
+        }
+        // Look for any field with a value
+        for (const field of fields) {
+            if (field in content && typeof content[field] === 'string') {
+                const value = this.normalizeValue(content[field], field);
+                if (value) {
+                    // If requireValid is true, only return valid GTS IDs
+                    if (requireValid) {
+                        if (gts_1.Gts.isValidGtsID(value)) {
+                            return { field, value };
+                        }
+                    }
+                    else {
+                        // Return any non-empty value
+                        return { field, value };
+                    }
+                }
+            }
+        }
+        return null;
+    }
+    static isJsonSchema(content) {
+        if (typeof content !== 'object' || content === null) {
+            return false;
+        }
+        // Check for JSON Schema meta-schema
+        // Issue #25: A document is a schema ONLY if $schema field is present
+        const schemaField = content['$schema'] || content['$$schema'];
+        if (typeof schemaField === 'string') {
+            // Standard JSON Schema meta-schema URLs
+            if (schemaField.includes('json-schema.org')) {
+                return true;
+            }
+            // GTS schema reference (ends with ~)
+            if (schemaField.startsWith(types_1.GTS_URI_PREFIX) || schemaField.startsWith(types_1.GTS_PREFIX)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    static extractID(content, schemaContent) {
+        const config = getDefaultConfig();
+        let id = '';
+        let schemaId = null;
+        let selectedEntityField;
+        let selectedSchemaIdField;
+        const isSchema = this.isJsonSchema(content);
+        if (typeof content === 'object' && content !== null) {
+            // Extract entity ID (look for any non-empty value, preferring valid GTS IDs)
+            const entityResult = this.findFirstValidField(content, config.entityIdFields);
+            if (entityResult) {
+                id = entityResult.value;
+                selectedEntityField = entityResult.field;
+            }
+            // Check if entity ID is a valid GTS ID
+            const isValidGtsId = id && gts_1.Gts.isValidGtsID(id);
+            // An ID has a "chain" if there's a ~ somewhere in the middle (not just at the end)
+            // e.g., "gts.a.b.c.d.v1~x.y.z.w.v2" or "gts.a.b.c.d.v1~x.y.z.w.v2~" both have chains
+            // but "gts.a.b.c.d.v1~" does NOT have a chain (it's a base type)
+            const hasChain = isValidGtsId &&
+                (() => {
+                    // Find first ~
+                    const firstTilde = id.indexOf('~');
+                    if (firstTilde === -1)
+                        return false;
+                    // Check if there's anything meaningful after the first ~
+                    const afterTilde = id.substring(firstTilde + 1);
+                    // If ends with ~, remove it for chain check
+                    const checkPart = afterTilde.endsWith('~') ? afterTilde.slice(0, -1) : afterTilde;
+                    return checkPart.length > 0;
+                })();
+            if (isSchema) {
+                // For schemas: extract schema_id based on rules
+                // Rule: For base schemas, schema_id is the $schema field value
+                // Rule: For derived schemas (chained $id), schema_id is the parent type from the chain
+                if (hasChain && id.endsWith('~')) {
+                    // Derived schema - extract parent type from chain
+                    // e.g., "gts.x.core.events.type.v1~x.commerce.orders.order_placed.v1.0~"
+                    // -> schema_id = "gts.x.core.events.type.v1~"
+                    const withoutTrailingTilde = id.slice(0, -1);
+                    const lastTilde = withoutTrailingTilde.lastIndexOf('~');
+                    if (lastTilde > 0) {
+                        schemaId = id.substring(0, lastTilde + 1);
+                        selectedSchemaIdField = selectedEntityField;
+                    }
+                }
+                else if (hasChain && !id.endsWith('~')) {
+                    // Chained instance ID in schema (shouldn't happen, but handle it)
+                    const lastTilde = id.lastIndexOf('~');
+                    if (lastTilde > 0) {
+                        schemaId = id.substring(0, lastTilde + 1);
+                        selectedSchemaIdField = selectedEntityField;
+                    }
+                }
+                else {
+                    // Base schema (single segment type or no $id) - use $schema field value
+                    const schemaResult = this.findFirstValidField(content, ['$schema', '$$schema']);
+                    if (schemaResult) {
+                        schemaId = schemaResult.value;
+                        selectedSchemaIdField = schemaResult.field;
+                    }
+                }
+            }
+            else {
+                // For instances (non-schemas):
+                // $id without $schema means the doc is an instance, NOT a schema
+                // Even if $id ends with ~, without $schema it's not treated as a schema
+                // So we should NOT derive schema_id from $id alone
+                // Skip $id for non-schemas - $id without $schema should not be used for schema_id
+                const isIdFromDollarId = selectedEntityField === '$id' || selectedEntityField === '$$id';
+                if (hasChain && !isIdFromDollarId) {
+                    // Extract schema ID from chain (only if not from $id)
+                    const lastTilde = id.lastIndexOf('~');
+                    if (lastTilde > 0 && !id.endsWith('~')) {
+                        schemaId = id.substring(0, lastTilde + 1);
+                        selectedSchemaIdField = selectedEntityField;
+                    }
+                }
+                if (schemaId === null && !isIdFromDollarId) {
+                    // No chain or chain didn't provide schema_id - try explicit schema fields
+                    // But don't use schema_id_fields that are $id variants (they were already checked above)
+                    const explicitSchemaFields = config.schemaIdFields.filter((f) => f !== '$id' && f !== '$$id');
+                    const schemaResult = this.findFirstValidField(content, explicitSchemaFields, true);
+                    if (schemaResult) {
+                        schemaId = schemaResult.value;
+                        selectedSchemaIdField = schemaResult.field;
+                    }
+                }
+                // If schema_id is still null, check regular chained ID (including from $id)
+                if (schemaId === null && hasChain && !id.endsWith('~')) {
+                    const lastTilde = id.lastIndexOf('~');
+                    if (lastTilde > 0) {
+                        schemaId = id.substring(0, lastTilde + 1);
+                        selectedSchemaIdField = selectedEntityField;
+                    }
+                }
+            }
+        }
+        // Try to extract from schemaContent if provided and schemaId is still null
+        if (schemaId === null && schemaContent && typeof schemaContent === 'object') {
+            const schemaEntityResult = this.findFirstValidField(schemaContent, config.entityIdFields);
+            if (schemaEntityResult) {
+                schemaId = schemaEntityResult.value;
+            }
+        }
+        return {
+            id,
+            schema_id: schemaId,
+            selected_entity_field: selectedEntityField,
+            selected_schema_id_field: selectedSchemaIdField,
+            is_schema: isSchema,
+        };
+    }
+}
+exports.GtsExtractor = GtsExtractor;
+//# sourceMappingURL=extract.js.map

package/dist/extract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract.js","sourceRoot":"","sources":["../src/extract.ts"],"names":[],"mappings":";;;AAQA,4CAgBC;AAxBD,mCAAoE;AACpE,+BAA4B;AAO5B,SAAgB,gBAAgB;IAC9B,OAAO;QACL,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC;QAC1G,cAAc,EAAE;YACd,SAAS;YACT,UAAU;YACV,QAAQ;YACR,SAAS;YACT,MAAM;YACN,OAAO;YACP,SAAS;YACT,UAAU;YACV,MAAM;YACN,QAAQ;SACT;KACF,CAAC;AACJ,CAAC;AAED,MAAa,YAAY;IACf,MAAM,CAAC,cAAc,CAAC,KAAa,EAAE,SAAkB;QAC7D,IAAI,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAE9B,0EAA0E;QAC1E,IAAI,SAAS,KAAK,KAAK,IAAI,UAAU,CAAC,UAAU,CAAC,sBAAc,CAAC,EAAE,CAAC;YACjE,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;aAAM,IAAI,UAAU,CAAC,UAAU,CAAC,sBAAc,CAAC,EAAE,CAAC;YACjD,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,sBAAc,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAChC,OAAY,EACZ,MAAgB,EAChB,eAAwB,KAAK;QAE7B,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACpD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,kCAAkC;QAClC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,KAAK,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;gBACzD,IAAI,KAAK,EAAE,CAAC;oBACV,qDAAqD;oBACrD,IAAI,YAAY,EAAE,CAAC;wBACjB,IAAI,SAAG,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;4BAC5B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;wBAC1B,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,6BAA6B;wBAC7B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;oBAC1B,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,YAAY,CAAC,OAAY;QACtC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACpD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,oCAAoC;QACpC,qEAAqE;QACrE,MAAM,WAAW,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;QAC9D,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,wCAAwC;YACxC,IAAI,WAAW,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;gBAC5C,OAAO,IAAI,CAAC;YACd,CAAC;YACD,qCAAqC;YACrC,IAAI,WAAW,CAAC,UAAU,CAAC,sBAAc,CAAC,IAAI,WAAW,CAAC,UAAU,CAAC,kBAAU,CAAC,EAAE,CAAC;gBACjF,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,OAAY,EAAE,aAAmB;QAChD,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC;QAClC,IAAI,EAAE,GAAG,EAAE,CAAC;QACZ,IAAI,QAAQ,GAAkB,IAAI,CAAC;QACnC,IAAI,mBAAuC,CAAC;QAC5C,IAAI,qBAAyC,CAAC;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAE5C,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACpD,6EAA6E;YAC7E,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;YAC9E,IAAI,YAAY,EAAE,CAAC;gBACjB,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC;gBACxB,mBAAmB,GAAG,YAAY,CAAC,KAAK,CAAC;YAC3C,CAAC;YAED,uCAAuC;YACvC,MAAM,YAAY,GAAG,EAAE,IAAI,SAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YAEhD,mFAAmF;YACnF,qFAAqF;YACrF,iEAAiE;YACjE,MAAM,QAAQ,GACZ,YAAY;gBACZ,CAAC,GAAG,EAAE;oBACJ,eAAe;oBACf,MAAM,UAAU,GAAG,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;oBACnC,IAAI,UAAU,KAAK,CAAC,CAAC;wBAAE,OAAO,KAAK,CAAC;oBACpC,yDAAyD;oBACzD,MAAM,UAAU,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;oBAChD,4CAA4C;oBAC5C,MAAM,SAAS,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;oBAClF,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC9B,CAAC,CAAC,EAAE,CAAC;YAEP,IAAI,QAAQ,EAAE,CAAC;gBACb,gDAAgD;gBAChD,+DAA+D;gBAC/D,uFAAuF;gBACvF,IAAI,QAAQ,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACjC,kDAAkD;oBAClD,yEAAyE;oBACzE,8CAA8C;oBAC9C,MAAM,oBAAoB,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC7C,MAAM,SAAS,GAAG,oBAAoB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;oBACxD,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;wBAClB,QAAQ,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;wBAC1C,qBAAqB,GAAG,mBAAmB,CAAC;oBAC9C,CAAC;gBACH,CAAC;qBAAM,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACzC,kEAAkE;oBAClE,MAAM,SAAS,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;oBACtC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;wBAClB,QAAQ,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;wBAC1C,qBAAqB,GAAG,mBAAmB,CAAC;oBAC9C,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,wEAAwE;oBACxE,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC;oBAChF,IAAI,YAAY,EAAE,CAAC;wBACjB,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC;wBAC9B,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC;oBAC7C,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,+BAA+B;gBAC/B,iEAAiE;gBACjE,wEAAwE;gBACxE,mDAAmD;gBAEnD,kFAAkF;gBAClF,MAAM,gBAAgB,GAAG,mBAAmB,KAAK,KAAK,IAAI,mBAAmB,KAAK,MAAM,CAAC;gBAEzF,IAAI,QAAQ,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBAClC,sDAAsD;oBACtD,MAAM,SAAS,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;oBACtC,IAAI,SAAS,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;wBACvC,QAAQ,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;wBAC1C,qBAAqB,GAAG,mBAAmB,CAAC;oBAC9C,CAAC;gBACH,CAAC;gBAED,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBAC3C,0EAA0E;oBAC1E,yFAAyF;oBACzF,MAAM,oBAAoB,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,MAAM,CAAC,CAAC;oBAC9F,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,EAAE,IAAI,CAAC,CAAC;oBACnF,IAAI,YAAY,EAAE,CAAC;wBACjB,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC;wBAC9B,qBAAqB,GAAG,YAAY,CAAC,KAAK,CAAC;oBAC7C,CAAC;gBACH,CAAC;gBAED,4EAA4E;gBAC5E,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvD,MAAM,SAAS,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;oBACtC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;wBAClB,QAAQ,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;wBAC1C,qBAAqB,GAAG,mBAAmB,CAAC;oBAC9C,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,2EAA2E;QAC3E,IAAI,QAAQ,KAAK,IAAI,IAAI,aAAa,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;YAC5E,MAAM,kBAAkB,GAAG,IAAI,CAAC,mBAAmB,CAAC,aAAa,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;YAC1F,IAAI,kBAAkB,EAAE,CAAC;gBACvB,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC;YACtC,CAAC;QACH,CAAC;QAED,OAAO;YACL,EAAE;YACF,SAAS,EAAE,QAAQ;YACnB,qBAAqB,EAAE,mBAAmB;YAC1C,wBAAwB,EAAE,qBAAqB;YAC/C,SAAS,EAAE,QAAQ;SACpB,CAAC;IACJ,CAAC;CACF;AA1LD,oCA0LC"}

package/dist/gts.d.ts

@@ -0,0 +1,18 @@
+import { GtsID, ValidationResult, ParseResult, MatchResult, UUIDResult } from './types';
+export declare class Gts {
+    static parseGtsID(id: string): GtsID;
+    private static splitPreservingTilde;
+    private static parseSegment;
+    static isValidGtsID(id: string): boolean;
+    static validateGtsID(id: string): ValidationResult;
+    static parseID(id: string): ParseResult;
+    static isType(id: string): boolean;
+    static toUUID(id: string): string;
+    static idToUUID(id: string): UUIDResult;
+    static matchIDPattern(candidate: string, pattern: string): MatchResult;
+    private static validateWildcard;
+    private static parseGtsIDInternal;
+    private static wildcardMatch;
+    private static matchSegments;
+}
+//# sourceMappingURL=gts.d.ts.map

package/dist/gts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gts.d.ts","sourceRoot":"","sources":["../src/gts.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,EAIL,gBAAgB,EAChB,WAAW,EACX,WAAW,EACX,UAAU,EACX,MAAM,SAAS,CAAC;AAMjB,qBAAa,GAAG;IACd,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,KAAK;IAQpC,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAsBnC,OAAO,CAAC,MAAM,CAAC,YAAY;IAuJ3B,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAYxC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB;IA2BlD,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW;IAgBvC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAIlC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM;IAIjC,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU;IAgBvC,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,WAAW;IAoDtE,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAiD/B,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAwEjC,OAAO,CAAC,MAAM,CAAC,aAAa;IAmB5B,OAAO,CAAC,MAAM,CAAC,aAAa;CA8E7B"}