@baijimu/cmodel 1.1.0 → 1.1.1

package/README.md

@@ -3,7 +3,7 @@
 Strict TypeScript types and parser for Baijimu CModel Error Contract `1.0.0`.
 
 ```bash
-npm install @baijimu/cmodel@1.1.0
+npm install @baijimu/cmodel@1.1.1
 ```
 
 ```ts

package/dist/parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,cAAc,EAQpB,MAAM,YAAY,CAAC;AAqBpB,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAK1C;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC,CAAC;AAEhE,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,OAAO,EACd,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,GACvB,cAAc,CAAC,CAAC,CAAC,CAiEnB"}
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,cAAc,EAEpB,MAAM,YAAY,CAAC;AAIpB,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAK1C;AAED,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC,CAAC;AAEhE,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,OAAO,EACd,SAAS,EAAE,UAAU,CAAC,CAAC,CAAC,GACvB,cAAc,CAAC,CAAC,CAAC,CAsCnB"}

package/dist/parser.js

@@ -1,22 +1,5 @@
 import { CONTRACT_VERSION, } from "./types.js";
 const codePattern = /^(?:0|[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*)$/;
-const reasonPattern = /^[A-Z][A-Z0-9]*(?:_[A-Z0-9]+)*$/;
-const domainPattern = /^[a-z0-9]+(?:-[a-z0-9]+)*(?:\.[a-z0-9]+(?:-[a-z0-9]+)*)+$/;
-const servicePattern = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
-const operationPattern = /^[a-z0-9]+(?:[._-][a-z0-9]+)*$/;
-const categories = new Set([
-    "validation",
-    "auth",
-    "permission",
-    "not_found",
-    "conflict",
-    "rate_limit",
-    "upstream_timeout",
-    "upstream_rate_limit",
-    "upstream_unavailable",
-    "internal",
-    "cancelled",
-]);
 export class CModelContractError extends Error {
     path;
     constructor(path, message) {
@@ -27,13 +10,7 @@ export class CModelContractError extends Error {
 }
 export function parseCModelResponse(httpStatus, input, parseData) {
     const envelope = envelopeAt(input, "$");
-    requiredKeys(envelope, "$", [
-        "contractVersion",
-        "errorCode",
-        "value",
-        "data",
-        "systemCurrentTime",
-    ]);
+    requiredKeys(envelope, "$", ["contractVersion", "errorCode", "data"]);
     const contractVersion = stringAt(envelope.contractVersion, "$.contractVersion", 1, 64);
     if (contractVersion !== CONTRACT_VERSION) {
         fail("$.contractVersion", `unsupported contract version ${contractVersion}`);
@@ -42,8 +19,6 @@ export function parseCModelResponse(httpStatus, input, parseData) {
     if (!codePattern.test(errorCode)) {
         fail("$.errorCode", "must be 0 or upper snake case");
     }
-    const value = stringAt(envelope.value, "$.value", 0, 512);
-    const systemCurrentTime = safeIntegerAt(envelope.systemCurrentTime, "$.systemCurrentTime", 0);
     const httpSuccess = httpStatus >= 200 && httpStatus < 300;
     if (httpStatus === 204) {
         fail("$httpStatus", "CModel responses cannot use 204 No Content");
@@ -52,16 +27,11 @@ export function parseCModelResponse(httpStatus, input, parseData) {
         if (!httpSuccess) {
             fail("$httpStatus", "non-2xx status cannot carry a success envelope");
         }
-        if ("error" in envelope) {
-            fail("$.error", "success response cannot contain error");
-        }
         const data = envelope.data === null ? null : parseData(envelope.data, "$.data");
         return {
             contractVersion: CONTRACT_VERSION,
             errorCode: "0",
-            value,
             data,
-            systemCurrentTime,
         };
     }
     if (httpSuccess) {
@@ -70,152 +40,12 @@ export function parseCModelResponse(httpStatus, input, parseData) {
     if (envelope.data !== null) {
         fail("$.data", "failure response data must be null");
     }
-    if (!("error" in envelope)) {
-        fail("$.error", "failure response must contain error");
-    }
-    const error = parseError(envelope.error, "$.error");
-    if (error.code !== errorCode) {
-        fail("$.error.code", "must equal errorCode");
-    }
-    if (error.userMessage !== value) {
-        fail("$.value", "must equal error.userMessage");
-    }
     return {
         contractVersion: CONTRACT_VERSION,
         errorCode,
-        value,
         data: null,
-        systemCurrentTime,
-        error,
-    };
-}
-function parseError(input, path) {
-    const value = objectAt(input, path, [
-        "code",
-        "domain",
-        "reason",
-        "category",
-        "message",
-        "userMessage",
-        "retryable",
-        "source",
-        "trace",
-        "upstream",
-        "causes",
-        "violations",
-    ]);
-    requiredKeys(value, path, [
-        "code",
-        "domain",
-        "reason",
-        "category",
-        "message",
-        "userMessage",
-        "retryable",
-        "source",
-        "trace",
-    ]);
-    const code = stringAt(value.code, `${path}.code`, 1, 128);
-    if (code === "0" || !codePattern.test(code))
-        fail(`${path}.code`, "invalid failure code");
-    const domain = stringAt(value.domain, `${path}.domain`, 3, 128);
-    if (!domainPattern.test(domain))
-        fail(`${path}.domain`, "invalid domain");
-    const reason = stringAt(value.reason, `${path}.reason`, 1, 96);
-    if (!reasonPattern.test(reason))
-        fail(`${path}.reason`, "invalid reason");
-    const category = stringAt(value.category, `${path}.category`, 1, 64);
-    if (!categories.has(category))
-        fail(`${path}.category`, "unknown category");
-    const message = stringAt(value.message, `${path}.message`, 1, 1024);
-    const userMessage = stringAt(value.userMessage, `${path}.userMessage`, 1, 512);
-    if (typeof value.retryable !== "boolean")
-        fail(`${path}.retryable`, "must be boolean");
-    const source = parseSource(value.source, `${path}.source`);
-    const trace = parseTrace(value.trace, `${path}.trace`);
-    const upstream = value.upstream === undefined ? undefined : parseUpstream(value.upstream, `${path}.upstream`);
-    const causes = value.causes === undefined ? undefined : arrayAt(value.causes, `${path}.causes`, 1, 16).map((cause, index) => parseCause(cause, `${path}.causes[${index}]`));
-    const violations = value.violations === undefined ? undefined : arrayAt(value.violations, `${path}.violations`, 1, 100).map((violation, index) => parseViolation(violation, `${path}.violations[${index}]`));
-    return {
-        code,
-        domain,
-        reason,
-        category: category,
-        message,
-        userMessage,
-        retryable: value.retryable,
-        source,
-        trace,
-        ...(upstream === undefined ? {} : { upstream }),
-        ...(causes === undefined ? {} : { causes }),
-        ...(violations === undefined ? {} : { violations }),
-    };
-}
-function parseSource(input, path) {
-    const value = objectAt(input, path, ["service", "operation"]);
-    requiredKeys(value, path, ["service"]);
-    const service = stringAt(value.service, `${path}.service`, 1, 96);
-    if (!servicePattern.test(service))
-        fail(`${path}.service`, "must use lower-kebab-case");
-    const operation = value.operation === undefined ? undefined : stringAt(value.operation, `${path}.operation`, 1, 160);
-    if (operation !== undefined && !operationPattern.test(operation))
-        fail(`${path}.operation`, "contains unsupported characters");
-    return { service, ...(operation === undefined ? {} : { operation }) };
-}
-function parseTrace(input, path) {
-    const value = objectAt(input, path, ["requestId", "traceId"]);
-    requiredKeys(value, path, ["requestId"]);
-    const requestId = stringAt(value.requestId, `${path}.requestId`, 1, 256);
-    const traceId = value.traceId === undefined ? undefined : stringAt(value.traceId, `${path}.traceId`, 1, 256);
-    return { requestId, ...(traceId === undefined ? {} : { traceId }) };
-}
-function parseUpstream(input, path) {
-    const value = objectAt(input, path, ["service", "status", "code", "retryAfterMillis"]);
-    requiredKeys(value, path, ["service"]);
-    const service = stringAt(value.service, `${path}.service`, 1, 96);
-    const status = value.status === undefined ? undefined : integerAt(value.status, `${path}.status`, 100, 599);
-    const code = value.code === undefined ? undefined : stringAt(value.code, `${path}.code`, 1, 256);
-    const retryAfterMillis = value.retryAfterMillis === undefined ? undefined : safeIntegerAt(value.retryAfterMillis, `${path}.retryAfterMillis`, 0);
-    return {
-        service,
-        ...(status === undefined ? {} : { status }),
-        ...(code === undefined ? {} : { code }),
-        ...(retryAfterMillis === undefined ? {} : { retryAfterMillis }),
     };
 }
-function parseCause(input, path) {
-    const value = objectAt(input, path, ["code", "domain", "reason", "source"]);
-    requiredKeys(value, path, ["code", "domain", "reason", "source"]);
-    const code = stringAt(value.code, `${path}.code`, 1, 128);
-    const domain = stringAt(value.domain, `${path}.domain`, 3, 128);
-    const reason = stringAt(value.reason, `${path}.reason`, 1, 96);
-    if (code === "0" || !codePattern.test(code))
-        fail(`${path}.code`, "invalid cause code");
-    if (!domainPattern.test(domain))
-        fail(`${path}.domain`, "invalid domain");
-    if (!reasonPattern.test(reason))
-        fail(`${path}.reason`, "invalid reason");
-    return { code, domain, reason, source: parseSource(value.source, `${path}.source`) };
-}
-function parseViolation(input, path) {
-    const value = objectAt(input, path, ["path", "reason", "message"]);
-    requiredKeys(value, path, ["path", "reason", "message"]);
-    const violationPath = stringAt(value.path, `${path}.path`, 1, 256);
-    const reason = stringAt(value.reason, `${path}.reason`, 1, 96);
-    if (!reasonPattern.test(reason))
-        fail(`${path}.reason`, "invalid reason");
-    return { path: violationPath, reason, message: stringAt(value.message, `${path}.message`, 1, 512) };
-}
-function objectAt(input, path, allowedKeys) {
-    if (typeof input !== "object" || input === null || Array.isArray(input))
-        fail(path, "must be an object");
-    const value = input;
-    const allowed = new Set(allowedKeys);
-    for (const key of Object.keys(value))
-        if (!allowed.has(key))
-            fail(`${path}.${key}`, "unknown field");
-    return value;
-}
 function envelopeAt(input, path) {
     if (typeof input !== "object" || input === null || Array.isArray(input))
         fail(path, "must be an object");
@@ -234,21 +64,6 @@ function stringAt(input, path, minimum, maximum) {
         fail(path, `length must be between ${minimum} and ${maximum}`);
     return input;
 }
-function integerAt(input, path, minimum, maximum) {
-    if (!Number.isInteger(input) || typeof input !== "number" || input < minimum || input > maximum)
-        fail(path, `must be an integer between ${minimum} and ${maximum}`);
-    return input;
-}
-function safeIntegerAt(input, path, minimum) {
-    if (typeof input !== "number" || !Number.isSafeInteger(input) || input < minimum)
-        fail(path, `must be a safe integer greater than or equal to ${minimum}`);
-    return input;
-}
-function arrayAt(input, path, minimum, maximum) {
-    if (!Array.isArray(input) || input.length < minimum || input.length > maximum)
-        fail(path, `must contain between ${minimum} and ${maximum} items`);
-    return input;
-}
 function fail(path, message) {
     throw new CModelContractError(path, message);
 }

package/dist/types.d.ts

@@ -42,17 +42,12 @@ export interface CModelError {
 export interface CModelSuccess<T> {
     readonly contractVersion: typeof CONTRACT_VERSION;
     readonly errorCode: "0";
-    readonly value: string;
     readonly data: T | null;
-    readonly systemCurrentTime: number;
 }
 export interface CModelFailure {
     readonly contractVersion: typeof CONTRACT_VERSION;
     readonly errorCode: string;
-    readonly value: string;
     readonly data: null;
-    readonly systemCurrentTime: number;
-    readonly error: CModelError;
 }
 export type CModelResponse<T> = CModelSuccess<T> | CModelFailure;
 export declare function isCModelSuccess<T>(response: CModelResponse<T>): response is CModelSuccess<T>;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,EAAG,OAAgB,CAAC;AAEjD,MAAM,MAAM,aAAa,GACrB,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,WAAW,GACX,UAAU,GACV,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,sBAAsB,GACtB,UAAU,GACV,WAAW,CAAC;AAEhB,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACxC,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;CACjD;AAED,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,QAAQ,CAAC,eAAe,EAAE,OAAO,gBAAgB,CAAC;IAClD,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,eAAe,EAAE,OAAO,gBAAgB,CAAC;IAClD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;CAC7B;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC;AAEjE,wBAAgB,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,aAAa,CAAC,CAAC,CAAC,CAE5F"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,EAAG,OAAgB,CAAC;AAEjD,MAAM,MAAM,aAAa,GACrB,YAAY,GACZ,MAAM,GACN,YAAY,GACZ,WAAW,GACX,UAAU,GACV,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,sBAAsB,GACtB,UAAU,GACV,WAAW,CAAC;AAEhB,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;CAC9B;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACxC,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,cAAc,EAAE,CAAC;CACjD;AAED,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,QAAQ,CAAC,eAAe,EAAE,OAAO,gBAAgB,CAAC;IAClD,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,eAAe,EAAE,OAAO,gBAAgB,CAAC;IAClD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;CACrB;AAED,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC;AAEjE,wBAAgB,eAAe,CAAC,CAAC,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,aAAa,CAAC,CAAC,CAAC,CAE5F"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baijimu/cmodel",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Strict TypeScript parser and types for the Baijimu CModel Error Contract",
   "type": "module",
   "main": "./dist/index.js",