@stigmer/sdk 3.16.0 → 3.17.0

package/src/gen/plan.ts

@@ -0,0 +1,138 @@
+// Code generated by stigmer-codegen. DO NOT EDIT.
+
+import { wrapError } from "./errors.js";
+import { stripUndefined } from "./proto-utils.js";
+import { create } from "@bufbuild/protobuf";
+import { createClient, type Client, type Transport } from "@connectrpc/connect";
+import { PlanSchema, type Plan } from "@stigmer/protos/ai/stigmer/billing/plan/v1/api_pb";
+import { PlanCommandController } from "@stigmer/protos/ai/stigmer/billing/plan/v1/command_pb";
+import { PlanIdSchema, ListPlansInputSchema, PlansSchema, type ListPlansInput, type Plans } from "@stigmer/protos/ai/stigmer/billing/plan/v1/io_pb";
+import { PlanQueryController } from "@stigmer/protos/ai/stigmer/billing/plan/v1/query_pb";
+import { PlanSpecSchema, PlanInstrument, PlanTermsSchema } from "@stigmer/protos/ai/stigmer/billing/plan/v1/spec_pb";
+import { ApiResourceVisibility } from "@stigmer/protos/ai/stigmer/commons/apiresource/enum_pb";
+import { ApiResourceMetadataSchema } from "@stigmer/protos/ai/stigmer/commons/apiresource/metadata_pb";
+import { Feature, EntitlementLimitsSchema, EntitlementsSchema } from "@stigmer/protos/ai/stigmer/platform/v1/entitlement_pb";
+
+/** Provides operations on plan resources. */
+export class PlanClient {
+  private readonly command: Client<typeof PlanCommandController>;
+  private readonly query: Client<typeof PlanQueryController>;
+
+  constructor(transport: Transport) {
+    this.command = createClient(PlanCommandController, transport);
+    this.query = createClient(PlanQueryController, transport);
+  }
+
+  async create(input: PlanInput): Promise<Plan> {
+    try {
+      return await this.command.create(buildPlanProto(input));
+    } catch (e) { throw wrapError(e); }
+  }
+
+  async retire(id: string): Promise<Plan> {
+    try {
+      return await this.command.retire(create(PlanIdSchema, { value: id }));
+    } catch (e) { throw wrapError(e); }
+  }
+
+  async get(id: string): Promise<Plan> {
+    try {
+      return await this.query.get(create(PlanIdSchema, { value: id }));
+    } catch (e) { throw wrapError(e); }
+  }
+
+  async list(input: ListPlansInput): Promise<Plans> {
+    try {
+      return await this.query.list(input);
+    } catch (e) { throw wrapError(e); }
+  }
+}
+
+/** Input for creating/updating a Plan. */
+export interface PlanInput {
+  /**
+   * The resource's `metadata.id`, for exact update addressing when set
+   * from a loaded resource. Required for updates to platform-scoped
+   * (org-less) kinds, where the org+slug fallback cannot match. On
+   * create, the cloud server stamps its own id regardless; the OSS
+   * server honors a caller-supplied id (existing apply semantics).
+   */
+  id?: string;
+  name: string;
+  slug?: string;
+  org: string;
+  labels?: Record<string, string>;
+  visibility?: ApiResourceVisibility;
+  instrument: PlanInstrument;
+  entitlements: EntitlementsInput;
+  terms?: PlanTermsInput;
+  description?: string;
+}
+
+/** SDK input type for Entitlements. */
+export interface EntitlementsInput {
+  limits?: EntitlementLimitsInput;
+  features?: Feature[];
+}
+
+/** SDK input type for EntitlementLimits. */
+export interface EntitlementLimitsInput {
+  maxOrganizations?: number;
+  maxUsers?: number;
+  includedManagedOrganizations?: number;
+}
+
+/** SDK input type for PlanTerms. */
+export interface PlanTermsInput {
+  monthlyMinimumMicros?: bigint;
+  usageShareBasisPoints?: number;
+  perExtraOrganizationMicros?: bigint;
+  annualPriceMicros?: bigint;
+}
+
+function buildEntitlementLimitsProto(input: EntitlementLimitsInput) {
+  return Object.assign(create(EntitlementLimitsSchema), stripUndefined({
+    maxOrganizations: input.maxOrganizations,
+    maxUsers: input.maxUsers,
+    includedManagedOrganizations: input.includedManagedOrganizations,
+  }));
+}
+
+function buildEntitlementsProto(input: EntitlementsInput) {
+  const msg = create(EntitlementsSchema);
+  if (input.limits) msg.limits = buildEntitlementLimitsProto(input.limits);
+  if (input.features) msg.features = input.features;
+  return msg;
+}
+
+function buildPlanTermsProto(input: PlanTermsInput) {
+  return Object.assign(create(PlanTermsSchema), stripUndefined({
+    monthlyMinimumMicros: input.monthlyMinimumMicros,
+    usageShareBasisPoints: input.usageShareBasisPoints,
+    perExtraOrganizationMicros: input.perExtraOrganizationMicros,
+    annualPriceMicros: input.annualPriceMicros,
+  }));
+}
+
+export function buildPlanProto(input: PlanInput): Plan {
+  const entitlements = input.entitlements ? buildEntitlementsProto(input.entitlements) : undefined;
+  const terms = input.terms ? buildPlanTermsProto(input.terms) : undefined;
+  return Object.assign(create(PlanSchema), {
+    apiVersion: "billing.stigmer.ai/v1",
+    kind: "Plan",
+    metadata: Object.assign(create(ApiResourceMetadataSchema), {
+      ...(input.id && { id: input.id }),
+      name: input.name,
+      org: input.org,
+      ...(input.slug && { slug: input.slug }),
+      ...(input.labels && { labels: input.labels }),
+      ...(input.visibility && { visibility: input.visibility }),
+    }),
+    spec: Object.assign(create(PlanSpecSchema), stripUndefined({
+      instrument: input.instrument,
+      entitlements,
+      terms,
+      description: input.description,
+    })),
+  }) as Plan;
+}

package/src/gen/plugin.ts

@@ -2,7 +2,7 @@
 
 import { wrapError } from "./errors.js";
 import { stripUndefined } from "./proto-utils.js";
-import { type ResourceRef } from "./types.js";
+import { type ListParams, type ListResult, type ResourceRef } from "./types.js";
 import { create } from "@bufbuild/protobuf";
 import { createClient, type Client, type Transport } from "@connectrpc/connect";
 import { PluginSchema, type Plugin } from "@stigmer/protos/ai/stigmer/agentic/plugin/v1/api_pb";
@@ -14,15 +14,20 @@ import { ApiResourceKind } from "@stigmer/protos/ai/stigmer/commons/apiresource/
 import { ApiResourceVisibility } from "@stigmer/protos/ai/stigmer/commons/apiresource/enum_pb";
 import { ApiResourceReferenceSchema, type UpdateVisibilityInput } from "@stigmer/protos/ai/stigmer/commons/apiresource/io_pb";
 import { ApiResourceMetadataSchema, ApiResourceMetadataVersionSchema } from "@stigmer/protos/ai/stigmer/commons/apiresource/metadata_pb";
+import { PageInfoSchema } from "@stigmer/protos/ai/stigmer/commons/rpc/pagination_pb";
+import { SearchRequestSchema } from "@stigmer/protos/ai/stigmer/search/v1/io_pb";
+import { SearchService } from "@stigmer/protos/ai/stigmer/search/v1/query_pb";
 
 /** Provides operations on plugin resources. */
 export class PluginClient {
   private readonly command: Client<typeof PluginCommandController>;
   private readonly query: Client<typeof PluginQueryController>;
+  private readonly search: Client<typeof SearchService>;
 
   constructor(transport: Transport) {
     this.command = createClient(PluginCommandController, transport);
     this.query = createClient(PluginQueryController, transport);
+    this.search = createClient(SearchService, transport);
   }
 
   async push(input: PushPluginRequest): Promise<Plugin> {
@@ -72,6 +77,24 @@ export class PluginClient {
       return await this.query.listVersions(input);
     } catch (e) { throw wrapError(e); }
   }
+
+  async list(params: ListParams): Promise<ListResult> {
+    try {
+      const resp = await this.search.search(create(SearchRequestSchema, {
+        kinds: [ApiResourceKind.plugin],
+        query: params.query,
+        org: params.org,
+        excludePublic: params.excludePublic ?? false,
+        crossOrgPublic: params.crossOrgPublic ?? false,
+        page: params.page ? create(PageInfoSchema, params.page) : undefined,
+      }));
+      return {
+        entries: resp.entries,
+        totalCount: resp.totalCount,
+        totalPages: resp.totalPages,
+      };
+    } catch (e) { throw wrapError(e); }
+  }
 }
 
 /** Input for creating/updating a Plugin. */

package/src/gen/resource-availability.ts

@@ -41,4 +41,7 @@ export const KIND_TIERS: ReadonlyMap<ApiResourceKind, ResourceTier> = new Map([
   [ApiResourceKind.memory, ResourceTier.open_source],
   [ApiResourceKind.plugin, ResourceTier.open_source],
   [ApiResourceKind.project, ResourceTier.open_source],
+  [ApiResourceKind.plan, ResourceTier.cloud_only],
+  [ApiResourceKind.subscription, ResourceTier.cloud_only],
+  [ApiResourceKind.license, ResourceTier.cloud_only],
 ]);

package/src/gen/subscription.ts

@@ -0,0 +1,84 @@
+// Code generated by stigmer-codegen. DO NOT EDIT.
+
+import { wrapError } from "./errors.js";
+import { stripUndefined } from "./proto-utils.js";
+import { create } from "@bufbuild/protobuf";
+import { createClient, type Client, type Transport } from "@connectrpc/connect";
+import { SubscriptionSchema, type Subscription } from "@stigmer/protos/ai/stigmer/billing/subscription/v1/api_pb";
+import { SubscriptionCommandController } from "@stigmer/protos/ai/stigmer/billing/subscription/v1/command_pb";
+import { ChangePlanInputSchema, CancelSubscriptionInputSchema, GetSubscriptionForOrganizationInputSchema, GetEntitlementsInputSchema, GetEntitlementsOutputSchema, type ChangePlanInput, type CancelSubscriptionInput, type GetSubscriptionForOrganizationInput, type GetEntitlementsInput, type GetEntitlementsOutput } from "@stigmer/protos/ai/stigmer/billing/subscription/v1/io_pb";
+import { SubscriptionQueryController } from "@stigmer/protos/ai/stigmer/billing/subscription/v1/query_pb";
+import { SubscriptionSpecSchema } from "@stigmer/protos/ai/stigmer/billing/subscription/v1/spec_pb";
+import { ApiResourceVisibility } from "@stigmer/protos/ai/stigmer/commons/apiresource/enum_pb";
+import { ApiResourceMetadataSchema } from "@stigmer/protos/ai/stigmer/commons/apiresource/metadata_pb";
+
+/** Provides operations on subscription resources. */
+export class SubscriptionClient {
+  private readonly command: Client<typeof SubscriptionCommandController>;
+  private readonly query: Client<typeof SubscriptionQueryController>;
+
+  constructor(transport: Transport) {
+    this.command = createClient(SubscriptionCommandController, transport);
+    this.query = createClient(SubscriptionQueryController, transport);
+  }
+
+  async changePlan(input: ChangePlanInput): Promise<Subscription> {
+    try {
+      return await this.command.changePlan(input);
+    } catch (e) { throw wrapError(e); }
+  }
+
+  async cancel(input: CancelSubscriptionInput): Promise<Subscription> {
+    try {
+      return await this.command.cancel(input);
+    } catch (e) { throw wrapError(e); }
+  }
+
+  async getForOrganization(input: GetSubscriptionForOrganizationInput): Promise<Subscription> {
+    try {
+      return await this.query.getForOrganization(input);
+    } catch (e) { throw wrapError(e); }
+  }
+
+  async getEntitlements(input: GetEntitlementsInput): Promise<GetEntitlementsOutput> {
+    try {
+      return await this.query.getEntitlements(input);
+    } catch (e) { throw wrapError(e); }
+  }
+}
+
+/** Input for creating/updating a Subscription. */
+export interface SubscriptionInput {
+  /**
+   * The resource's `metadata.id`, for exact update addressing when set
+   * from a loaded resource. Required for updates to platform-scoped
+   * (org-less) kinds, where the org+slug fallback cannot match. On
+   * create, the cloud server stamps its own id regardless; the OSS
+   * server honors a caller-supplied id (existing apply semantics).
+   */
+  id?: string;
+  name: string;
+  slug?: string;
+  org: string;
+  labels?: Record<string, string>;
+  visibility?: ApiResourceVisibility;
+  planId: string;
+}
+
+export function buildSubscriptionProto(input: SubscriptionInput): Subscription {
+  return Object.assign(create(SubscriptionSchema), {
+    apiVersion: "billing.stigmer.ai/v1",
+    kind: "Subscription",
+    metadata: Object.assign(create(ApiResourceMetadataSchema), {
+      ...(input.id && { id: input.id }),
+      name: input.name,
+      org: input.org,
+      ...(input.slug && { slug: input.slug }),
+      ...(input.labels && { labels: input.labels }),
+      ...(input.visibility && { visibility: input.visibility }),
+    }),
+    spec: Object.assign(create(SubscriptionSpecSchema), stripUndefined({
+      planId: input.planId,
+    })),
+  }) as Subscription;
+}

package/src/index.ts

@@ -283,6 +283,24 @@ export {
   toPlatformClientUpdateInput,
   type PlatformClientInput,
 } from "./gen/platformclient.js";
+// The billing kinds (cloud_only): the plan catalog, an organization's
+// subscription, and issued licenses. The entitlement input types are
+// emitted once per module that uses them, identical in shape; this barrel
+// exports the plan's copy. A subscription is created by the payment system,
+// never by a client, so no input type is exported for it.
+export {
+  PlanClient,
+  type PlanInput,
+  type PlanTermsInput,
+  type EntitlementsInput,
+  type EntitlementLimitsInput,
+} from "./gen/plan.js";
+export { SubscriptionClient } from "./gen/subscription.js";
+export {
+  LicenseClient,
+  type LicenseInput,
+  type LicenseCustomerInput,
+} from "./gen/license.js";
 export {
   ProjectClient,
   toProjectUpdateInput,

package/src/platform.ts

@@ -1,10 +1,12 @@
 import { createClient, type Client, type Transport } from "@connectrpc/connect";
 import { create } from "@bufbuild/protobuf";
 import {
+  GetLicenseStatusInputSchema,
   GetServerInfoInputSchema,
   PlatformQueryController,
 } from "@stigmer/protos/ai/stigmer/platform/v1/server_info_pb";
 import type {
+  GetLicenseStatusOutput,
   GetServerInfoOutput,
   ServerEdition,
 } from "@stigmer/protos/ai/stigmer/platform/v1/server_info_pb";
@@ -25,11 +27,12 @@ export interface ServerInfo {
 }
 
 /**
- * Client for platform-level queries (server info, capabilities).
+ * Client for platform-level queries (server info, capabilities, license).
  *
  * The {@link getServerInfo} method is the authoritative source for
  * deployment mode detection. It replaces URL-based hostname guessing
- * with a server-reported value.
+ * with a server-reported value. {@link getLicenseStatus} is its sibling
+ * for the license the server holds; every edition answers it.
  */
 export class PlatformClient {
   private readonly platform: Client<typeof PlatformQueryController>;
@@ -62,4 +65,24 @@ export class PlatformClient {
       throw wrapError(e);
     }
   }
+
+  /**
+   * Retrieve the state of the license the connected server holds.
+   *
+   * Every edition answers: open source and Stigmer Cloud report `absent`
+   * (neither holds a key); a Stigmer Enterprise deployment reports the
+   * state of its configured ticket with the verified claims. Requires a
+   * signed-in caller. The generated output is returned as it is, so the
+   * presence contract it documents (claims exactly when a ticket verified,
+   * key id whenever one was presented) reaches the caller unchanged.
+   */
+  async getLicenseStatus(): Promise<GetLicenseStatusOutput> {
+    try {
+      return await this.platform.getLicenseStatus(
+        create(GetLicenseStatusInputSchema, {}),
+      );
+    } catch (e) {
+      throw wrapError(e);
+    }
+  }
 }