@notation/resource 0.13.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.ts

@@ -0,0 +1,352 @@
+type IfAllPropertiesOptional<T, Y, N> = T extends Partial<T> ? (Partial<T> extends T ? Y : N) : N;
+type OptionalIfAllPropertiesOptional<K extends string, T> = IfAllPropertiesOptional<T, {
+    [Key in K]?: T;
+}, {
+    [Key in K]: T;
+}>;
+type Fallback<T, U> = T extends undefined ? U : T;
+type NoInfer<T> = [T][T extends any ? 0 : never];
+/**
+ * Flattens an intersection into a single object type.
+ *
+ * Keeps mapped types readable in IntelliSense without the assignability
+ * checks a conditional-based unwrap would cost.
+ */
+type Simplify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+/**
+ * Deeply makes all properties optional.
+ */
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+type OptionalKeys<T> = {
+    [K in keyof T]: undefined extends T[K] ? never : K;
+}[keyof T];
+/**
+ * Pick the required (non-optional) keys from T.
+ */
+type OmitOptional<T> = Pick<T, OptionalKeys<T>>;
+/**
+ * Pick the optional keys from T.
+ */
+type PickOptional<T> = Omit<T, OptionalKeys<T>>;
+
+/**
+ * Structural holder for a value type.
+ *
+ * Used as a phantom type carrier: schema value types are resolved from the
+ * resource's API schema, so items only carry metadata. Where a narrower type
+ * than the API's is wanted, `valueType: typed<T>()` overrides it. Any zod
+ * type is also structurally assignable, so zod validators can be used as
+ * overrides without this package depending on zod.
+ */
+type TypedValue<T> = {
+    _output: T;
+};
+/**
+ * Phantom value-type override for a schema item.
+ * Purely type-level; carries no runtime information.
+ */
+declare const typed: <T>() => TypedValue<T>;
+type DefineResourceApiSchema = {
+    Key: any;
+    CreateParams: any;
+    UpdateParams: any;
+    ReadResult: any;
+};
+/**
+ * A schema item is metadata about one property of a resource.
+ *
+ * Its value type is taken from the resource's API schema (see
+ * {@link ResolveSchema}); `valueType` is only needed to override that, or to
+ * type properties that exist in no API type.
+ */
+type SchemaItem<T = any> = {
+    valueType?: TypedValue<T>;
+    presence: "required" | "optional";
+    sensitive?: true;
+    hidden?: true;
+    volatile?: true;
+} & ({
+    propertyType: "param";
+    immutable?: true;
+    defaultValue?: T;
+    primaryKey?: true;
+    secondaryKey?: true;
+} | {
+    propertyType: "computed";
+    primaryKey?: true;
+} | {
+    propertyType: "derived";
+});
+/** A schema as authored: metadata per property. */
+type Schema = Record<string, SchemaItem<any>>;
+/**
+ * A schema whose items all carry a resolved value type.
+ *
+ * Deliberately loose (the mappers read `valueType` and the metadata flags
+ * conditionally): schema safety is enforced where schemas are authored, via
+ * {@link SchemaFromApi}, not in the type plumbing downstream of it.
+ */
+type ResolvedSchema = Record<string, any>;
+type UpdateParamsOf<Api extends DefineResourceApiSchema> = Fallback<Api["UpdateParams"], Api["CreateParams"]>;
+type ReadResultOf<Api extends DefineResourceApiSchema> = Fallback<Api["ReadResult"], {}>;
+/**
+ * The value type of schema item `K`: an explicit `valueType` override wins,
+ * otherwise the type comes from the API schema (params take precedence over
+ * read results, since read results often widen param types).
+ */
+type SchemaItemValue<Api extends DefineResourceApiSchema, S extends Schema, K extends keyof S> = S[K] extends {
+    valueType: TypedValue<infer T>;
+} ? T : K extends keyof Api["CreateParams"] ? Exclude<Api["CreateParams"][K], undefined> : K extends keyof Api["Key"] ? Exclude<Api["Key"][K], undefined> : K extends keyof UpdateParamsOf<Api> ? Exclude<UpdateParamsOf<Api>[K], undefined> : K extends keyof ReadResultOf<Api> ? Exclude<ReadResultOf<Api>[K], undefined> : MissingValueType<K>;
+/**
+ * Marker for schema keys found in no API schema type and lacking a
+ * `valueType` override. Deliberately unusable, so the mistake surfaces at
+ * the first use of the property rather than silently typing it `unknown`.
+ */
+type MissingValueType<K> = {
+    error: "Schema key not found in API schema types; add it there or set an explicit valueType";
+    key: K;
+};
+/**
+ * Pairs each schema item with its value type, resolved from the API schema.
+ * Computed once per resource, when the schema is defined.
+ */
+type ResolveSchema<Api extends DefineResourceApiSchema, S extends Schema> = {
+    [K in keyof S]: S[K] & {
+        valueType: TypedValue<SchemaItemValue<Api, S, K>>;
+    };
+};
+type ComputedPrimaryKey<S extends ResolvedSchema> = FallbackToVoid<MapSchema<S, {
+    propertyType: "param";
+}, "primaryKey">>;
+type FallbackToVoid<T> = {} extends T ? void : T;
+type CompoundKey<S extends ResolvedSchema> = MapSchema<S, never, "primaryKey" | "secondaryKey">;
+type Params<S extends ResolvedSchema> = MapSchema<S, {
+    propertyType: "computed" | "derived";
+}>;
+type Result<S extends ResolvedSchema> = DeepPartial<MapSchema<S, {
+    propertyType: "param" | "derived";
+}>>;
+type Output<S extends ResolvedSchema> = MapSchema<S>;
+type State<S extends ResolvedSchema> = MapSchema<S, {
+    hidden: true;
+}>;
+/**
+ * What a schema must look like for a given API schema: propertyType,
+ * presence and mutability are forced per key by where (and how) the key
+ * appears in the API types. A `valueType` override, when given, must stay
+ * assignable to the API's type for that key.
+ */
+type SchemaFromApi<ApiCompoundKey, ApiCreateParams, ApiUpdateParams, ApiReadResult> = {
+    [K in keyof ApiCompoundKey]: SchemaItem<ApiCompoundKey[K]> & ({
+        primaryKey: true;
+    } | {
+        secondaryKey: true;
+    });
+} & {
+    [K in keyof OmitOptional<Omit<ApiCreateParams, keyof ApiCompoundKey>>]: SchemaItem<ApiCreateParams[K]> & {
+        propertyType: "param";
+        presence: "required";
+    };
+} & {
+    [K in keyof PickOptional<Omit<ApiCreateParams, keyof ApiCompoundKey>>]: SchemaItem<ApiCreateParams[K]> & {
+        propertyType: "param";
+        presence: "optional";
+    };
+} & {
+    [K in keyof Omit<ApiCreateParams, keyof ApiUpdateParams>]: SchemaItem<ApiCreateParams[K]> & {
+        propertyType: "param";
+        immutable: true;
+    };
+} & {
+    [K in keyof Omit<ApiReadResult, keyof ApiCreateParams | keyof ApiCompoundKey>]: SchemaItem<ApiReadResult[K]> & {
+        propertyType: "computed";
+    };
+};
+/**
+ * Maps `valueType` to its output type.
+ * Makes optional fields optional.
+ * Excludes properties matching the `ExcludeConditions` type.
+ * When `IncludeKey` is given, keeps only items that have that property.
+ */
+type MapSchema<S extends ResolvedSchema, ExcludeConditions = never, IncludeKey = any> = Simplify<{
+    [K in keyof S as S[K] extends {
+        presence: "optional";
+    } | ExcludeConditions ? never : IncludeKey extends keyof S[K] ? K : never]: S[K]["valueType"]["_output"];
+} & {
+    [K in keyof S as S[K] extends ExcludeConditions ? never : S[K] extends {
+        presence: "optional";
+    } ? IncludeKey extends keyof S[K] ? K : never : never]?: S[K]["valueType"]["_output"];
+}>;
+
+/** Plain data passed from one attempt of an operation to the next. */
+type ResourceOperationContext = Readonly<Record<string, unknown>>;
+/**
+ * A `read` operation throws this error when no resource exists for its key.
+ */
+declare class ResourceNotFoundError extends Error {
+    readonly _tag: "ResourceNotFoundError";
+    constructor(message: string, options?: ErrorOptions);
+    static is(error: unknown): error is ResourceNotFoundError;
+}
+/**
+ * An operation throws this error when it has not finished.
+ *
+ * The reconciler waits for `retryAfterMs`, then calls the same operation again
+ * with `callbackContext`.
+ */
+declare class ResourceOperationPendingError extends Error {
+    readonly _tag: "ResourceOperationPendingError";
+    /** Milliseconds to wait before the next attempt. */
+    readonly retryAfterMs: number;
+    /** Plain data passed to the next attempt of the same operation. */
+    readonly callbackContext?: ResourceOperationContext;
+    constructor(message: string, options: ErrorOptions & {
+        retryAfterMs: number;
+        callbackContext?: ResourceOperationContext;
+    });
+    static is(error: unknown): error is ResourceOperationPendingError;
+}
+type ResourceOperationSignal = ResourceNotFoundError | ResourceOperationPendingError;
+
+type ResourceType = `${string}/${string}/${string}`;
+type ResourceOpts<C, D> = OptionalIfAllPropertiesOptional<"config", C> & OptionalIfAllPropertiesOptional<"dependencies", D> & {
+    id: string;
+};
+/**
+ * The object types a resource's schema gives rise to.
+ *
+ * These are derived from the schema exactly once, when `defineSchema` is
+ * called (see {@link InferResourceTypes}). Everything downstream — operation
+ * callbacks, instances, dependency inference — is generic over this small
+ * bag of plain object types, so the schema literal never re-enters type
+ * inference.
+ */
+type ResourceTypes = {
+    params: any;
+    compoundKey: any;
+    primaryKey: any;
+    result: any;
+    state: any;
+    output: any;
+};
+type InferResourceTypes<S extends ResolvedSchema> = {
+    params: Params<S>;
+    compoundKey: CompoundKey<S>;
+    primaryKey: ComputedPrimaryKey<S>;
+    result: Result<S>;
+    state: State<S>;
+    output: Output<S>;
+};
+interface BaseResource {
+    readonly type: ResourceType;
+    readonly schema: Schema;
+    readonly config: any;
+    id: string;
+    groupId: number;
+    groupType: string;
+    readonly output: {};
+    readonly dependencies: Record<string, BaseResource | void>;
+    readonly key: {};
+    create: (params: any, context?: ResourceOperationContext) => Promise<{} | void>;
+    read?: (key: any, context?: ResourceOperationContext) => Promise<Record<string, any>>;
+    update?: (key: any, patch: any, params: any, state: any, context?: ResourceOperationContext) => Promise<void>;
+    delete: (key: any, state: any, context?: ResourceOperationContext) => Promise<void>;
+    getParams(): Promise<{}>;
+    toState(output: {}): {};
+    toComparable(output: {}): {};
+    setOutput(result: {}): void;
+    deriveParams?: (opts: {
+        id: string;
+        config: any;
+        deps: any;
+    }) => Record<string, any> | Promise<Record<string, any>>;
+}
+declare abstract class Resource<T extends ResourceTypes = ResourceTypes, D extends Record<string, BaseResource | void> = {}, C extends Record<string, any> = T["params"]> implements BaseResource {
+    config: C;
+    id: string;
+    groupId: number;
+    groupType: string;
+    output: T["output"];
+    dependencies: NoInfer<D>;
+    abstract type: ResourceType;
+    abstract schema: Schema;
+    abstract create: (params: T["params"], context?: ResourceOperationContext) => Promise<T["primaryKey"]>;
+    abstract read?: (key: T["compoundKey"], context?: ResourceOperationContext) => Promise<T["result"]>;
+    abstract update?: (key: T["compoundKey"], patch: T["params"], params: T["params"], state: T["state"], context?: ResourceOperationContext) => Promise<void>;
+    abstract delete: (key: T["compoundKey"], state: T["state"], context?: ResourceOperationContext) => Promise<void>;
+    abstract deriveParams(opts: {
+        id: string;
+        config: C;
+        deps: D;
+    }): Record<string, any> | Promise<Record<string, any>>;
+    constructor(opts: ResourceOpts<C, D>);
+    get key(): T["compoundKey"];
+    setOutput(output: T["output"]): void;
+    toComparable(output: T["output"]): T["output"];
+    toState(output: T["output"]): T["state"];
+    getParams(): Promise<T["params"]>;
+}
+type DefineResourceMeta = {
+    type: ResourceType;
+};
+type ResourceOperationsOptions<T extends ResourceTypes, IntrinsicParams extends Partial<T["params"]>> = {
+    create: (params: T["params"], context?: ResourceOperationContext) => Promise<T["primaryKey"]>;
+    read?: (key: T["compoundKey"], context?: ResourceOperationContext) => Promise<T["result"]>;
+    update?: (key: T["compoundKey"], patch: T["params"], params: T["params"], state: T["state"], context?: ResourceOperationContext) => Promise<void>;
+    delete: (key: T["compoundKey"], state: T["state"], context?: ResourceOperationContext) => Promise<void>;
+    deriveParams?: (opts: {
+        config: Partial<T["params"]>;
+    }) => IntrinsicParams | Promise<IntrinsicParams>;
+};
+type ResourceDependenciesBuilder<T extends ResourceTypes, IntrinsicParams extends Partial<T["params"]>, Dependencies extends Record<string, BaseResource | void>> = {
+    deriveParams: <DepAwareParams extends Partial<T["params"]>>(deriveParams: (opts: {
+        id: string;
+        config: T["params"];
+        deps: Dependencies;
+    }) => DepAwareParams | Promise<DepAwareParams>) => ResourceClass<T, Dependencies, Omit<T["params"], keyof IntrinsicParams | keyof DepAwareParams>>;
+};
+type ResourceClass<T extends ResourceTypes, D extends Record<string, BaseResource | void> = {}, C extends Record<string, any> = T["params"], IntrinsicParams extends Partial<T["params"]> = {}> = {
+    new (opts: ResourceOpts<C, D>): Resource<T, D, C>;
+    readonly type: ResourceType;
+    requireDependencies: <Dependencies extends Record<string, BaseResource | void>>() => ResourceDependenciesBuilder<T, IntrinsicParams, Dependencies>;
+};
+type ResourceSchemaBuilder<T extends ResourceTypes> = {
+    defineOperations: <IntrinsicParams extends Partial<T["params"]> = {}>(opts: ResourceOperationsOptions<T, IntrinsicParams>) => ResourceClass<T, {}, Omit<T["params"], keyof IntrinsicParams>, IntrinsicParams>;
+};
+type ResourceBuilder<ApiSchema extends DefineResourceApiSchema> = {
+    defineSchema: <S extends Schema & SchemaFromApi<ApiSchema["Key"], ApiSchema["CreateParams"], Fallback<ApiSchema["UpdateParams"], ApiSchema["CreateParams"]>, Fallback<ApiSchema["ReadResult"], {}>>>(schema: S) => ResourceSchemaBuilder<InferResourceTypes<ResolveSchema<ApiSchema, S>>>;
+};
+declare function defineResource<ApiSchema extends DefineResourceApiSchema>(meta: DefineResourceMeta): ResourceBuilder<ApiSchema>;
+declare const resource: typeof defineResource;
+
+type ResourceGroupOptions = {
+    /**
+     * Optional pre-assigned ID. Used outside graph collection.
+     */
+    id?: number;
+    dependencies?: Record<string, number>;
+    [key: string]: any;
+};
+declare abstract class ResourceGroup {
+    #private;
+    type: string;
+    id: number;
+    dependencies: Record<string, number>;
+    config: Record<string, any>;
+    resources: BaseResource[];
+    constructor(type: string, opts: ResourceGroupOptions);
+    add<T extends BaseResource>(resource: T): T;
+    findResource<T extends new (...opts: any[]) => BaseResource>(ResourceClass: T): InstanceType<T> | undefined;
+}
+
+type ResourceGraph = {
+    resourceGroups: ResourceGroup[];
+    resources: BaseResource[];
+};
+declare function collectResourceGraph(evaluate: () => unknown | Promise<unknown>): Promise<ResourceGraph>;
+
+export { type BaseResource, type CompoundKey, type ComputedPrimaryKey, type DeepPartial, type DefineResourceApiSchema, type DefineResourceMeta, type Fallback, type IfAllPropertiesOptional, type InferResourceTypes, type MapSchema, type NoInfer, type OmitOptional, type OptionalIfAllPropertiesOptional, type Output, type Params, type PickOptional, type ResolveSchema, type ResolvedSchema, Resource, type ResourceBuilder, type ResourceClass, type ResourceDependenciesBuilder, type ResourceGraph, ResourceGroup, type ResourceGroupOptions, ResourceNotFoundError, type ResourceOperationContext, ResourceOperationPendingError, type ResourceOperationSignal, type ResourceOperationsOptions, type ResourceOpts, type ResourceSchemaBuilder, type ResourceType, type ResourceTypes, type Result, type Schema, type SchemaFromApi, type SchemaItem, type Simplify, type State, type TypedValue, collectResourceGraph, defineResource, resource, typed };

package/dist/index.js

@@ -0,0 +1,216 @@
+// src/resource.schema.ts
+var typed = () => ({});
+
+// src/resource.ts
+var Resource = class {
+  config;
+  id;
+  groupId = -1;
+  groupType = "";
+  output = null;
+  dependencies = {};
+  constructor(opts) {
+    this.id = opts.id;
+    this.config = opts.config || {};
+    this.dependencies = opts.dependencies || {};
+    return this;
+  }
+  get key() {
+    const key = {};
+    for (const [k, v] of Object.entries(this.schema)) {
+      if (v.primaryKey || v.secondaryKey) {
+        key[k] = this.output[k];
+      }
+    }
+    return key;
+  }
+  setOutput(output) {
+    this.output = output;
+  }
+  toComparable(output) {
+    const parsed = {};
+    for (const [k, v] of Object.entries(this.schema)) {
+      if (v.volatile) continue;
+      if (v.hidden) continue;
+      if (v.propertyType !== "param") continue;
+      if (k in output) {
+        parsed[k] = output[k];
+      }
+    }
+    return parsed;
+  }
+  toState(output) {
+    const parsed = {};
+    for (const [k, v] of Object.entries(this.schema)) {
+      if (v.hidden) continue;
+      if (k in output) {
+        parsed[k] = output[k];
+      }
+    }
+    return parsed;
+  }
+  async getParams() {
+    return {
+      ...this.config,
+      ...await this.deriveParams({
+        id: this.id,
+        config: this.config,
+        deps: this.dependencies
+      })
+    };
+  }
+};
+function defineResource(meta) {
+  return {
+    defineSchema(schema) {
+      const builder = {
+        defineOperations(opts) {
+          class SimpleResource extends Resource {
+            static type = meta.type;
+            type = meta.type;
+            schema = schema;
+            create = opts.create;
+            read = opts.read ? opts.read : void 0;
+            update = opts.update ? opts.update : void 0;
+            delete = opts.delete;
+            async deriveParams() {
+              if (!opts.deriveParams) return {};
+              return await opts.deriveParams({
+                config: this.config
+              });
+            }
+            static requireDependencies() {
+              return {
+                deriveParams(deriveParams) {
+                  return class DependencyAwareResource extends SimpleResource {
+                    async deriveParams() {
+                      const superParams = await super.deriveParams();
+                      return {
+                        ...superParams,
+                        ...await deriveParams({
+                          id: this.id,
+                          config: this.config,
+                          deps: this.dependencies
+                        })
+                      };
+                    }
+                  };
+                }
+              };
+            }
+          }
+          return SimpleResource;
+        }
+      };
+      return builder;
+    }
+  };
+}
+var resource = defineResource;
+
+// src/resource-operation.ts
+var ResourceNotFoundError = class extends Error {
+  _tag = "ResourceNotFoundError";
+  constructor(message, options) {
+    super(message, options);
+    this.name = "ResourceNotFoundError";
+  }
+  static is(error) {
+    return hasTag(error, "ResourceNotFoundError");
+  }
+};
+var ResourceOperationPendingError = class extends Error {
+  _tag = "ResourceOperationPendingError";
+  /** Milliseconds to wait before the next attempt. */
+  retryAfterMs;
+  /** Plain data passed to the next attempt of the same operation. */
+  callbackContext;
+  constructor(message, options) {
+    super(message, options);
+    this.name = "ResourceOperationPendingError";
+    this.retryAfterMs = options.retryAfterMs;
+    this.callbackContext = options.callbackContext;
+    if (!Number.isFinite(options.retryAfterMs) || options.retryAfterMs < 0) {
+      throw new RangeError("retryAfterMs must be a non-negative number");
+    }
+  }
+  static is(error) {
+    return hasTag(error, "ResourceOperationPendingError") && "retryAfterMs" in error && typeof error.retryAfterMs === "number";
+  }
+};
+function hasTag(error, tag) {
+  return typeof error === "object" && error !== null && "_tag" in error && error._tag === tag;
+}
+
+// src/resource-collection.ts
+var activeCollection;
+async function collectResourceGraph(evaluate) {
+  if (activeCollection) {
+    throw new Error("A resource graph is already being collected.");
+  }
+  const collection = {
+    graph: { resourceGroups: [], resources: [] },
+    nextResourceGroupId: 0
+  };
+  activeCollection = collection;
+  try {
+    await evaluate();
+    return collection.graph;
+  } finally {
+    activeCollection = void 0;
+  }
+}
+function getActiveResourceCollection() {
+  return activeCollection;
+}
+
+// src/resource-group.ts
+var ResourceGroup = class {
+  type;
+  id;
+  dependencies;
+  config;
+  resources;
+  #graph;
+  constructor(type, opts) {
+    const { dependencies, id, ...config } = opts;
+    const collection = getActiveResourceCollection();
+    this.type = type;
+    this.#graph = collection?.graph;
+    this.id = collection ? collection.nextResourceGroupId++ : id ?? -1;
+    this.dependencies = dependencies || {};
+    this.config = config || {};
+    this.resources = [];
+    collection?.graph.resourceGroups.push(this);
+    return this;
+  }
+  add(resource2) {
+    if (this.#graph) {
+      if (this.#graph.resources.includes(resource2)) {
+        throw new Error(
+          `Resource ${resource2.type} has already been registered.`
+        );
+      }
+      this.#graph.resources.push(resource2);
+    } else if (this.resources.includes(resource2)) {
+      throw new Error(`Resource ${resource2.type} has already been registered.`);
+    }
+    resource2.groupId = this.id;
+    resource2.groupType = this.type;
+    this.resources.push(resource2);
+    return resource2;
+  }
+  findResource(ResourceClass) {
+    return this.resources.find((r) => r instanceof ResourceClass);
+  }
+};
+export {
+  Resource,
+  ResourceGroup,
+  ResourceNotFoundError,
+  ResourceOperationPendingError,
+  collectResourceGraph,
+  defineResource,
+  resource,
+  typed
+};

package/package.json

@@ -0,0 +1,20 @@
+{
+  "type": "module",
+  "name": "@notation/resource",
+  "version": "0.13.0",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup --clean",
+    "dev": "tsup --watch"
+  }
+}