@farthershore/product 0.0.0 → 0.2.0

package/dist/types/business.d.ts

@@ -1,5 +1,6 @@
-import type { CacheProfile, ActionSpecJson, CapabilityFileJson, FrontendComponentId, FrontendGateMode, FrontendManifestJson, GrantJson, ManifestBuildResult, MeterDefinitionJson, MigrationDeclJson, MigrationPinJson, MutationClass, CountedResourceJson, PlanLimitJson, PlanMeterJson, PlanSpecJson, PolicyFileJson, RoutesFileJson } from "./ir-types.js";
+import type { CacheProfile, ActionSpecJson, CapabilityFileJson, FrontendComponentId, FrontendGateMode, FrontendManifestJson, GrantJson, ManifestBuildResult, MeterDefinitionJson, MigrationDeclJson, MigrationPinJson, MutationClass, CountedResourceJson, PlanLimitJson, PlanMeterJson, PlanSpecJson, PolicyFileJson, ProductPoliciesJson, ProductCustomerContextJson, RoutesFileJson } from "./ir-types.js";
 import type { PriceSpec } from "./price.js";
+import { type ManifestResourceGraphSnapshot } from "./resource-graph.js";
 /** Brand symbol so the bin can recognize a Business across SDK copies
  *  (the repo's pinned SDK vs whatever loaded the entry). */
 export declare const BUSINESS_BRAND: unique symbol;
@@ -20,6 +21,14 @@ export type BusinessOptions = {
         token?: string;
     };
     billOn4xx?: boolean;
+    /** Product operator policies, e.g. zero-traffic cleanup report/PR mode. */
+    operatorPolicies?: ProductPoliciesJson;
+    /** Customer-context controls emitted as product.customer_context. */
+    customerContext?: {
+        identityRequirement?: ProductCustomerContextJson["identity_requirement"];
+        contextTokens?: ProductCustomerContextJson["context_tokens"];
+        portalAuth?: ProductCustomerContextJson["portal_auth"];
+    };
     billing?: {
         gracePeriodDays?: number;
         applyLimitUpgradesInstantly?: boolean;
@@ -182,17 +191,16 @@ export type PlanCapabilityGrant = {
     readonly capability: string;
     readonly limits?: Record<string, number | boolean>;
 };
+/**
+ * A synchronous Product SDK module. Use this to split a product across files:
+ * `product.use(configureMeters, configureRoutes, configurePlans)`.
+ */
+export type ProductModule = (product: Business) => void;
 export declare class Business {
     readonly [BUSINESS_BRAND] = true;
     readonly name: string;
     private readonly options;
-    private readonly meters;
-    private readonly resources;
-    private readonly plans;
-    private readonly features;
-    private readonly policies;
-    private readonly capabilities;
-    private migrations;
+    private readonly graph;
     private frontendManifest?;
     private productPatch;
     /** Sugar for binding API routes to features. */
@@ -228,6 +236,9 @@ export declare class Business {
     feature(key: string, options?: FeatureOptions): FeatureRef;
     policy(name: string, options: PolicyOptions): PolicyRef;
     plan(key: string, options: PlanOptions): PlanRef;
+    use(...modules: ProductModule[]): Business;
+    /** Inspect the SDK-local declaration graph used to emit the Manifest IR. */
+    resourceGraph(): ManifestResourceGraphSnapshot;
     /** Assemble + validate the Manifest IR. Throws ManifestValidationError
      *  with structured issues when the declared state is invalid. */
     toIR(): ManifestBuildResult;
@@ -236,9 +247,23 @@ export declare class Business {
     private ensureFrontendManifest;
     private normalizeMigrationPlanRef;
     private normalizeMigrationTargetRef;
-    private assertUniqueMigrationId;
     private assertUniqueMigrationIds;
     private assertNewKey;
+    private assertGraphDependenciesSatisfied;
+    private getFeatureFile;
+    private registerFeatureFile;
+    private syncFeatureGraphNode;
+    private registerAction;
+    private syncFrontendGraphNode;
+    private capabilityDependsOn;
+    private policyDependsOn;
+    private featureDependsOn;
+    private actionDependsOn;
+    private planDependsOn;
+    private migrationDependsOn;
+    private frontendDependsOn;
+    private dependenciesFor;
+    private existingDependenciesFor;
 }
 export declare function isBusiness(value: unknown): value is Business;
-export declare function business(name: string, options: BusinessOptions): Business;
+export declare function business(name: string, options: BusinessOptions, configure?: ProductModule): Business;

package/dist/types/index.d.ts

@@ -14,7 +14,8 @@ export { price } from "./price.js";
 export { validateManifestIr, hashIr, canonicalIrJson } from "./validate.js";
 export { ManifestValidationError, ManifestBuilderError } from "./errors.js";
 export { SDK_VERSION } from "./version.js";
-export type { BusinessOptions, MeterOptions, CapabilityOptions, FrontendNavItemOptions, FrontendPageOptions, FrontendComponentOptions, FeatureOptions, RouteOptions, PolicyOptions, PlanOptions, MeterRef, PolicyRef, PlanRef, FeatureRef, CapabilityRef, PlanCapabilityGrant, } from "./business.js";
+export type { BusinessOptions, MeterOptions, ResourceOptions, CapabilityOptions, ActionOptions, FrontendNavItemOptions, FrontendPageOptions, FrontendComponentOptions, MigrationOptions, FeatureOptions, RouteOptions, PolicyOptions, PlanOptions, MeterRef, ResourceRef, ActionRef, PolicyRef, PlanRef, FeatureRef, CapabilityRef, PlanCapabilityGrant, ProductModule, } from "./business.js";
+export type { ManifestResourceGraphSnapshot, ManifestResourceKind, ManifestResourceUrn, } from "./resource-graph.js";
 export type { PriceSpec } from "./price.js";
 export type { ManifestIssue } from "./errors.js";
 export type { ValidationResult } from "./validate.js";

package/dist/types/ir-types.d.ts

@@ -197,6 +197,29 @@ export type CountedResourceJson = {
     subjectType?: string;
     countSource?: CountedResourceCountSourceJson;
 };
+export type ProductCleanupPolicyModeJson = "report" | "pull_request";
+export type ProductChangeApprovalRiskJson = "safe" | "non_blocking" | "economic_risk" | "blocking";
+export type ProductPoliciesJson = {
+    cleanup?: {
+        enabled?: boolean;
+        mode?: ProductCleanupPolicyModeJson;
+    };
+    change_approval?: {
+        auto_merge_max_risk?: "none" | "safe" | "non_blocking";
+        require_human_for?: ProductChangeApprovalRiskJson[];
+    };
+};
+export type CustomerIdentityRequirementJson = "org_only" | "org_and_user";
+export type CustomerPortalAuthStrategyJson = "clerk" | "test-personas";
+export type ProductCustomerContextJson = {
+    identity_requirement?: CustomerIdentityRequirementJson;
+    context_tokens?: {
+        enabled?: boolean;
+    };
+    portal_auth?: {
+        strategy: CustomerPortalAuthStrategyJson;
+    };
+};
 export type ProductBlockJson = {
     name: string;
     displayName?: string;
@@ -224,6 +247,8 @@ export type ProductSpecJson = {
     frontend?: FrontendManifestJson;
     migrations?: MigrationDeclJson[];
     resources?: CountedResourceJson[];
+    policies?: ProductPoliciesJson;
+    customer_context?: ProductCustomerContextJson;
     plans?: PlanSpecJson[];
     /** Legacy / advanced product blocks (usage, features, billing,
      *  webhooks, environments, add_ons, lifecycle, ephemeral, …) ride

package/dist/types/resource-graph.d.ts

@@ -0,0 +1,36 @@
+export type ManifestResourceKind = "product" | "meter" | "counted_resource" | "capability" | "policy" | "feature" | "action" | "plan" | "frontend" | "lifecycle_migration";
+export type ManifestResourceUrn = `urn:farthershore:product:${ManifestResourceKind}:${string}`;
+export type ManifestResourceRef = {
+    readonly kind: ManifestResourceKind;
+    readonly key: string;
+};
+export type ManifestResourceNode<T = unknown> = {
+    readonly urn: ManifestResourceUrn;
+    readonly kind: ManifestResourceKind;
+    readonly key: string;
+    readonly value: T;
+    readonly dependsOn: readonly ManifestResourceUrn[];
+    readonly declarationOrder: number;
+};
+export type ManifestResourceGraphSnapshot = {
+    readonly nodes: readonly Omit<ManifestResourceNode, "value">[];
+};
+export type MissingManifestResourceDependency = {
+    readonly from: ManifestResourceUrn;
+    readonly missing: ManifestResourceUrn;
+};
+export declare class ManifestResourceGraph {
+    private readonly nodes;
+    private declarationOrder;
+    register<T>(kind: ManifestResourceKind, key: string, value: T, dependsOn?: readonly ManifestResourceUrn[]): ManifestResourceNode<T>;
+    upsert<T>(kind: ManifestResourceKind, key: string, value: T, dependsOn?: readonly ManifestResourceUrn[]): ManifestResourceNode<T>;
+    clearKind(kind: ManifestResourceKind): void;
+    has(kind: ManifestResourceKind, key: string): boolean;
+    get<T>(kind: ManifestResourceKind, key: string): ManifestResourceNode<T> | null;
+    values<T>(kind: ManifestResourceKind): T[];
+    sortedValues<T>(kind: ManifestResourceKind, key: (value: T) => string): T[];
+    snapshot(): ManifestResourceGraphSnapshot;
+    missingDependencies(): MissingManifestResourceDependency[];
+}
+export declare function resourceUrn(kind: ManifestResourceKind, key: string): ManifestResourceUrn;
+export declare function resourceDependency(kind: ManifestResourceKind, key: string): ManifestResourceUrn;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farthershore/product",
-  "version": "0.0.0",
+  "version": "0.2.0",
   "description": "Farther Shore product-as-code SDK — declare your business in TypeScript",
   "type": "module",
   "main": "./dist/index.js",