@kindgi/types 0.1.7 → 0.1.8-rc.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export type * from './ids.js';
 export type * from './live.js';
 export type * from './refs.js';
 export type * from './result.js';
+export type * from './secret-scope.js';
 export type * from './temporal.js';
 export type * from './version.js';
 export type * from './webhook.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,mBAAmB,aAAa,CAAC;AACjC,mBAAmB,WAAW,CAAC;AAC/B,mBAAmB,UAAU,CAAC;AAC9B,mBAAmB,WAAW,CAAC;AAC/B,mBAAmB,WAAW,CAAC;AAC/B,mBAAmB,aAAa,CAAC;AACjC,mBAAmB,eAAe,CAAC;AACnC,mBAAmB,cAAc,CAAC;AAClC,mBAAmB,cAAc,CAAC;AAKlC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAIvC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,mBAAmB,aAAa,CAAC;AACjC,mBAAmB,WAAW,CAAC;AAC/B,mBAAmB,UAAU,CAAC;AAC9B,mBAAmB,WAAW,CAAC;AAC/B,mBAAmB,WAAW,CAAC;AAC/B,mBAAmB,aAAa,CAAC;AACjC,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,eAAe,CAAC;AACnC,mBAAmB,cAAc,CAAC;AAClC,mBAAmB,cAAc,CAAC;AAKlC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAIvC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,iCAAiC;AAYjC,uEAAuE;AACvE,qEAAqE;AACrE,+DAA+D;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,yEAAyE;AACzE,8DAA8D;AAC9D,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,iCAAiC;AAajC,uEAAuE;AACvE,qEAAqE;AACrE,+DAA+D;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,yEAAyE;AACzE,8DAA8D;AAC9D,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/result.d.ts

@@ -7,6 +7,7 @@
  * do not invent parallel Ok/Err representations.
  *
  * @example
+ * ```ts excerpt
  * function loadSchema(path: string): Result<Schema, SchemaLoadError> {
  *   try {
  *     return { kind: 'ok', value: parse(readFileSync(path)) };
@@ -17,6 +18,7 @@
  *
  * const r = loadSchema('./flow.schema.json');
  * if (r.kind === 'ok') { use(r.value); } else { handle(r.error); }
+ * ```
  */
 export type Result<T, E> = {
     readonly kind: 'ok';
@@ -29,7 +31,9 @@ export type Result<T, E> = {
  * Extract the success type from a Result.
  *
  * @example
+ * ```ts excerpt
  * type Value = OkOf<Result<number, string>>; // number
+ * ```
  */
 export type OkOf<R> = R extends {
     readonly kind: 'ok';
@@ -39,7 +43,9 @@ export type OkOf<R> = R extends {
  * Extract the error type from a Result.
  *
  * @example
+ * ```ts excerpt
  * type Failure = ErrOf<Result<number, string>>; // string
+ * ```
  */
 export type ErrOf<R> = R extends {
     readonly kind: 'err';

package/dist/result.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IACnB;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAC1C;IAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC"}
+{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IACnB;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAC1C;IAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,CAAC,GAAG,KAAK,CAAC"}

package/dist/secret-scope.d.ts

@@ -0,0 +1,16 @@
+import type { OrgId, ProjectId } from './ids.js';
+/**
+ * Where a secret an item names is read, as recorded on the item when it's
+ * registered: the item's tenant itself, one of its orgs, or one of its
+ * projects. The runtime reads the secret at that scope only.
+ */
+export type RecordedSecretScope = {
+    readonly kind: 'tenant';
+} | {
+    readonly kind: 'org';
+    readonly orgId: OrgId;
+} | {
+    readonly kind: 'project';
+    readonly projectId: ProjectId;
+};
+//# sourceMappingURL=secret-scope.d.ts.map

package/dist/secret-scope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret-scope.d.ts","sourceRoot":"","sources":["../src/secret-scope.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAEjD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,GAC3B;IAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GAC/C;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;CAAE,CAAC"}

package/dist/secret-scope.js

@@ -0,0 +1,4 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright (C) 2026 Kindgi Inc.
+export {};
+//# sourceMappingURL=secret-scope.js.map

package/dist/secret-scope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret-scope.js","sourceRoot":"","sources":["../src/secret-scope.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,iCAAiC"}

package/dist/version.d.ts

@@ -24,10 +24,12 @@ export type SchemaMajor = Brand<number, 'SchemaMajor'>;
  * semver, so replays and audit trails always know which version was in force.
  *
  * @example
+ * ```ts excerpt
  * const flowRef: VersionedRef<FlowId> = {
  *   id: 'acme.contract-review' as FlowId,
  *   version: '1.2.3' as Semver,
  * };
+ * ```
  */
 export interface VersionedRef<Id extends string> {
     readonly id: Id;

package/dist/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAEvD;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY,CAAC,EAAE,SAAS,MAAM;IAC7C,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;IAChB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,UAAU,GAAG,eAAe,GAAG,QAAQ,CAAC;AAE/F,mFAAmF;AACnF,MAAM,WAAW,iBAAiB;IAChC,yEAAyE;IACzE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAC;IACzC,uEAAuE;IACvE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAE7C;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAEvD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,YAAY,CAAC,EAAE,SAAS,MAAM;IAC7C,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;IAChB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,UAAU,GAAG,eAAe,GAAG,QAAQ,CAAC;AAE/F,mFAAmF;AACnF,MAAM,WAAW,iBAAiB;IAChC,yEAAyE;IACzE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,uBAAuB,CAAC;IACzC,uEAAuE;IACvE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kindgi/types",
-  "version": "0.1.7",
+  "version": "0.1.8-rc.0",
   "description": "Foundational TypeScript types shared across Kindgi. Branded IDs, timestamps, hashes, refs, Result, list filter / page shapes. Zero runtime dependencies; the only runtime export is the makeEnvName validator.",
   "license": "Apache-2.0",
   "repository": {

package/src/index.ts

@@ -7,6 +7,7 @@ export type * from './ids.js';
 export type * from './live.js';
 export type * from './refs.js';
 export type * from './result.js';
+export type * from './secret-scope.js';
 export type * from './temporal.js';
 export type * from './version.js';
 export type * from './webhook.js';

package/src/result.ts

@@ -10,6 +10,7 @@
  * do not invent parallel Ok/Err representations.
  *
  * @example
+ * ```ts excerpt
  * function loadSchema(path: string): Result<Schema, SchemaLoadError> {
  *   try {
  *     return { kind: 'ok', value: parse(readFileSync(path)) };
@@ -20,6 +21,7 @@
  *
  * const r = loadSchema('./flow.schema.json');
  * if (r.kind === 'ok') { use(r.value); } else { handle(r.error); }
+ * ```
  */
 export type Result<T, E> =
   | { readonly kind: 'ok'; readonly value: T }
@@ -29,7 +31,9 @@ export type Result<T, E> =
  * Extract the success type from a Result.
  *
  * @example
+ * ```ts excerpt
  * type Value = OkOf<Result<number, string>>; // number
+ * ```
  */
 export type OkOf<R> = R extends { readonly kind: 'ok'; readonly value: infer T } ? T : never;
 
@@ -37,6 +41,8 @@ export type OkOf<R> = R extends { readonly kind: 'ok'; readonly value: infer T }
  * Extract the error type from a Result.
  *
  * @example
+ * ```ts excerpt
  * type Failure = ErrOf<Result<number, string>>; // string
+ * ```
  */
 export type ErrOf<R> = R extends { readonly kind: 'err'; readonly error: infer E } ? E : never;

package/src/secret-scope.ts

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright (C) 2026 Kindgi Inc.
+
+import type { OrgId, ProjectId } from './ids.js';
+
+/**
+ * Where a secret an item names is read, as recorded on the item when it's
+ * registered: the item's tenant itself, one of its orgs, or one of its
+ * projects. The runtime reads the secret at that scope only.
+ */
+export type RecordedSecretScope =
+  | { readonly kind: 'tenant' }
+  | { readonly kind: 'org'; readonly orgId: OrgId }
+  | { readonly kind: 'project'; readonly projectId: ProjectId };

package/src/version.ts

@@ -30,10 +30,12 @@ export type SchemaMajor = Brand<number, 'SchemaMajor'>;
  * semver, so replays and audit trails always know which version was in force.
  *
  * @example
+ * ```ts excerpt
  * const flowRef: VersionedRef<FlowId> = {
  *   id: 'acme.contract-review' as FlowId,
  *   version: '1.2.3' as Semver,
  * };
+ * ```
  */
 export interface VersionedRef<Id extends string> {
   readonly id: Id;