@myapihq/sdk 1.2.6 → 1.2.8

package/dist/config.d.ts

@@ -3,6 +3,7 @@ export declare const DOMAIN_BASE: string;
 export declare const FUNNEL_BASE: string;
 export declare const FUNCTION_BASE: string;
 export declare const PAYMENTS_BASE: string;
+export declare const CONTAINER_BASE: string;
 export declare const IMAGE_BASE: string;
 export declare const WEBHOOK_BASE: string;
 export declare const WORKFLOW_BASE: string;

package/dist/config.js

@@ -8,7 +8,7 @@
 // local dev — `source scripts/local-env.sh` still points everything at
 // localhost:8080 regardless of the prod default.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CRM_BASE = exports.DATABASE_BASE = exports.LLM_BASE = exports.AUDIENCE_BASE = exports.COMPANY_BASE = exports.PEOPLE_BASE = exports.PIXEL_BASE = exports.URL_BASE = exports.STORAGE_BASE = exports.EMAIL_BASE = exports.WORKFLOW_BASE = exports.WEBHOOK_BASE = exports.IMAGE_BASE = exports.PAYMENTS_BASE = exports.FUNCTION_BASE = exports.FUNNEL_BASE = exports.DOMAIN_BASE = exports.HQ_BASE = void 0;
+exports.CRM_BASE = exports.DATABASE_BASE = exports.LLM_BASE = exports.AUDIENCE_BASE = exports.COMPANY_BASE = exports.PEOPLE_BASE = exports.PIXEL_BASE = exports.URL_BASE = exports.STORAGE_BASE = exports.EMAIL_BASE = exports.WORKFLOW_BASE = exports.WEBHOOK_BASE = exports.IMAGE_BASE = exports.CONTAINER_BASE = exports.PAYMENTS_BASE = exports.FUNCTION_BASE = exports.FUNNEL_BASE = exports.DOMAIN_BASE = exports.HQ_BASE = void 0;
 const GATEWAY = 'https://api.myapihq.com';
 exports.HQ_BASE = process.env.MYAPI_HQ_URL ?? process.env.MYAPI_API_BASE ?? GATEWAY;
 exports.DOMAIN_BASE = process.env.MYAPI_DOMAIN_URL ?? 'https://api.mydomainapi.com';
@@ -17,6 +17,7 @@ exports.FUNNEL_BASE = process.env.MYAPI_FUNNEL_URL ?? 'https://api.myfunnelapi.c
 // (mirrors the LLM/DATABASE/CRM pattern below).
 exports.FUNCTION_BASE = process.env.MYAPI_FUNCTION_URL ?? GATEWAY;
 exports.PAYMENTS_BASE = process.env.MYAPI_PAYMENTS_URL ?? GATEWAY;
+exports.CONTAINER_BASE = process.env.MYAPI_CONTAINER_URL ?? GATEWAY;
 exports.IMAGE_BASE = process.env.MYAPI_IMAGE_URL ?? 'https://api.myimageapi.com';
 exports.WEBHOOK_BASE = process.env.MYAPI_WEBHOOK_URL ?? 'https://api.mywebhookapi.com';
 exports.WORKFLOW_BASE = process.env.MYAPI_WORKFLOW_URL ?? 'https://api.myworkflowapi.com';

package/dist/container.d.ts

@@ -0,0 +1,54 @@
+import type { Exposes } from './exposes';
+export declare const EXPOSES: Exposes;
+export type ContainerType = 'service' | 'worker' | 'job';
+export interface Container {
+    id: string;
+    org_id: string;
+    name: string;
+    type: ContainerType;
+    cron_schedule?: string;
+    env: Record<string, unknown>;
+    cpu: string;
+    memory: string;
+    min_instances: number;
+    max_instances: number;
+    port: number;
+    url?: string;
+    status: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface CreatePayload {
+    name: string;
+    type?: ContainerType;
+    cron_schedule?: string;
+    env?: Record<string, unknown>;
+    cpu?: string;
+    memory?: string;
+    min_instances?: number;
+    max_instances?: number;
+    port?: number;
+}
+export interface CreateResponse {
+    container: Container;
+    scoped_api_key: string;
+    scoped_api_key_id: string;
+}
+export interface DeployResponse {
+    container_id: string;
+    revision_id: string;
+    url: string;
+    status: string;
+    scoped_api_key: string;
+}
+export declare function createContainer(apiKey: string, orgId: string, payload: CreatePayload): Promise<CreateResponse>;
+export declare function listContainers(apiKey: string, orgId: string): Promise<Container[]>;
+export declare function getContainer(apiKey: string, orgId: string, containerId: string): Promise<Container>;
+export declare function deleteContainer(apiKey: string, orgId: string, containerId: string): Promise<void>;
+export declare function deployContainer(apiKey: string, orgId: string, containerId: string, image: string): Promise<DeployResponse>;
+export interface LogEntry {
+    timestamp: string;
+    severity: string;
+    text: string;
+}
+export declare function getContainerLogs(apiKey: string, orgId: string, containerId: string, tail?: number): Promise<LogEntry[]>;

package/dist/container.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EXPOSES = void 0;
+exports.createContainer = createContainer;
+exports.listContainers = listContainers;
+exports.getContainer = getContainer;
+exports.deleteContainer = deleteContainer;
+exports.deployContainer = deployContainer;
+exports.getContainerLogs = getContainerLogs;
+const client_1 = require("./client");
+const config_1 = require("./config");
+// Backend: my-container-api per myapi-hq/internal/routes/container/. Phase 1
+// is metadata + scoped API key issuance; the Cloud Run build/deploy pipeline
+// is Phase 2 — `deployContainer` returns RUNTIME_UNAVAILABLE until it lands.
+exports.EXPOSES = [
+    'POST /container/orgs/{org_id}/containers',
+    'GET /container/orgs/{org_id}/containers',
+    'GET /container/orgs/{org_id}/containers/{id}',
+    'DELETE /container/orgs/{org_id}/containers/{id}',
+    'POST /container/orgs/{org_id}/containers/{id}/deploy',
+    'GET /container/orgs/{org_id}/containers/{id}/logs',
+];
+async function createContainer(apiKey, orgId, payload) {
+    return (0, client_1.request)('POST', `${config_1.CONTAINER_BASE}/container/orgs/${encodeURIComponent(orgId)}/containers`, apiKey, payload);
+}
+async function listContainers(apiKey, orgId) {
+    return (0, client_1.request)('GET', `${config_1.CONTAINER_BASE}/container/orgs/${encodeURIComponent(orgId)}/containers`, apiKey);
+}
+async function getContainer(apiKey, orgId, containerId) {
+    return (0, client_1.request)('GET', `${config_1.CONTAINER_BASE}/container/orgs/${encodeURIComponent(orgId)}/containers/${encodeURIComponent(containerId)}`, apiKey);
+}
+async function deleteContainer(apiKey, orgId, containerId) {
+    return (0, client_1.request)('DELETE', `${config_1.CONTAINER_BASE}/container/orgs/${encodeURIComponent(orgId)}/containers/${encodeURIComponent(containerId)}`, apiKey);
+}
+// deployContainer ships a revision from a pre-built image ref to Cloud Run
+// (source builds land in a later backend slice). Rotates the scoped key.
+async function deployContainer(apiKey, orgId, containerId, image) {
+    return (0, client_1.request)('POST', `${config_1.CONTAINER_BASE}/container/orgs/${encodeURIComponent(orgId)}/containers/${encodeURIComponent(containerId)}/deploy`, apiKey, { image });
+}
+// getContainerLogs returns recent runtime log entries, newest first.
+// `tail` caps the count (default 100, max 1000 server-side). An
+// undeployed container returns an empty array.
+async function getContainerLogs(apiKey, orgId, containerId, tail) {
+    const query = tail ? `?tail=${encodeURIComponent(String(tail))}` : '';
+    return (0, client_1.request)('GET', `${config_1.CONTAINER_BASE}/container/orgs/${encodeURIComponent(orgId)}/containers/${encodeURIComponent(containerId)}/logs${query}`, apiKey);
+}

package/dist/hq.d.ts

@@ -114,6 +114,18 @@ export declare function getBillingHistory(apiKey: string): Promise<{
     status: string;
     created_at: string;
 }[]>;
+export interface ServiceUsage {
+    service: string;
+    requests: number;
+    cost_display: string;
+}
+export interface BillingUsage {
+    period: 'month' | '30d';
+    since: string;
+    services: ServiceUsage[];
+    total_display: string;
+}
+export declare function getBillingUsage(apiKey: string, period?: 'month' | '30d'): Promise<BillingUsage>;
 export declare function setupPayment(apiKey: string): Promise<{
     url: string;
 }>;

package/dist/hq.js

@@ -22,6 +22,7 @@ exports.updateOrg = updateOrg;
 exports.deleteOrg = deleteOrg;
 exports.getBalance = getBalance;
 exports.getBillingHistory = getBillingHistory;
+exports.getBillingUsage = getBillingUsage;
 exports.setupPayment = setupPayment;
 exports.topUp = topUp;
 const client_1 = require("./client");
@@ -48,6 +49,7 @@ exports.EXPOSES = [
     'POST /hq/org-imports/{import_id}/confirm',
     'GET /hq/billing/balance',
     'GET /hq/billing/history',
+    'GET /hq/billing/usage',
     'POST /hq/billing/setup-payment',
     'POST /hq/billing/topup',
 ];
@@ -139,6 +141,12 @@ async function getBalance(apiKey) {
 async function getBillingHistory(apiKey) {
     return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/billing/history`, apiKey);
 }
+// getBillingUsage rolls up spend by service for a window: the current
+// calendar month (default) or the trailing 30 days ('30d').
+async function getBillingUsage(apiKey, period) {
+    const query = period ? `?period=${encodeURIComponent(period)}` : '';
+    return (0, client_1.request)('GET', `${config_1.HQ_BASE}/hq/billing/usage${query}`, apiKey);
+}
 async function setupPayment(apiKey) {
     return (0, client_1.request)('POST', `${config_1.HQ_BASE}/hq/billing/setup-payment`, apiKey);
 }

package/dist/index.d.ts

@@ -18,3 +18,4 @@ export * as database from './database';
 export * as crm from './crm';
 export * as fn from './function';
 export * as payments from './payments';
+export * as container from './container';

package/dist/index.js

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.payments = exports.fn = exports.crm = exports.database = exports.llm = exports.audience = exports.company = exports.people = exports.url = exports.workflow = exports.webhook = exports.storage = exports.pixel = exports.image = exports.funnel = exports.email = exports.domain = exports.hq = void 0;
+exports.container = exports.payments = exports.fn = exports.crm = exports.database = exports.llm = exports.audience = exports.company = exports.people = exports.url = exports.workflow = exports.webhook = exports.storage = exports.pixel = exports.image = exports.funnel = exports.email = exports.domain = exports.hq = void 0;
 __exportStar(require("./types"), exports);
 __exportStar(require("./client"), exports);
 // Note: config constants (STORAGE_BASE etc.) are NOT re-exported from the
@@ -63,3 +63,4 @@ exports.database = __importStar(require("./database"));
 exports.crm = __importStar(require("./crm"));
 exports.fn = __importStar(require("./function"));
 exports.payments = __importStar(require("./payments"));
+exports.container = __importStar(require("./container"));

package/dist/services.js

@@ -143,7 +143,9 @@ exports.SERVICES = [
     {
         module: 'crm',
         skill: 'my-crm-api',
-        domain: 'mycrmapi.com',
+        // Brand domain — mycrmapi.com was unavailable; mypipelineapi.com chosen
+        // and acquired. (Skill stays my-crm-api — domain/skill mismatch accepted.)
+        domain: 'mypipelineapi.com',
         description: 'The canonical store of engaged people + companies. Auto-ingest from inbound webhooks (configurable dot-path). Fixed lifecycle_stage enum, soft delete, event timeline.',
         category: 'data',
         status: 'ga',
@@ -218,4 +220,20 @@ exports.SERVICES = [
         status: 'preview',
         keywords: k('payments', 'stripe', 'checkout', 'billing', 'subscription'),
     },
+    {
+        // CLI top-level command + SDK namespace are both `container`; skill
+        // directory is `my-container-api`.
+        //
+        // Backend status: Phase 1 shipped (metadata + scoped API key). The
+        // Cloud Run build/deploy pipeline is Phase 2 — deploy returns
+        // RUNTIME_UNAVAILABLE until it lands. 'preview' reflects "usable
+        // surface, deploy not yet GA."
+        module: 'container',
+        skill: 'my-container-api',
+        domain: 'mycontainerapi.com',
+        description: 'Run containers on demand — long-running services, background workers, and scheduled jobs. The heavier-duty sibling of edge functions, for native deps and long execution.',
+        category: 'compute',
+        status: 'preview',
+        keywords: k('container', 'cloud-run', 'service', 'worker', 'job'),
+    },
 ];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@myapihq/sdk",
   "license": "Apache-2.0",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "TypeScript SDK for the MyAPI ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/config.ts

@@ -16,6 +16,7 @@ export const FUNNEL_BASE  = process.env.MYAPI_FUNNEL_URL  ?? 'https://api.myfunn
 // (mirrors the LLM/DATABASE/CRM pattern below).
 export const FUNCTION_BASE= process.env.MYAPI_FUNCTION_URL?? GATEWAY;
 export const PAYMENTS_BASE= process.env.MYAPI_PAYMENTS_URL?? GATEWAY;
+export const CONTAINER_BASE=process.env.MYAPI_CONTAINER_URL?? GATEWAY;
 export const IMAGE_BASE   = process.env.MYAPI_IMAGE_URL   ?? 'https://api.myimageapi.com';
 export const WEBHOOK_BASE = process.env.MYAPI_WEBHOOK_URL ?? 'https://api.mywebhookapi.com';
 export const WORKFLOW_BASE= process.env.MYAPI_WORKFLOW_URL?? 'https://api.myworkflowapi.com';

package/src/container.ts

@@ -0,0 +1,106 @@
+import { request } from './client';
+import { CONTAINER_BASE as BASE_URL } from './config';
+import type { Exposes } from './exposes';
+
+// Backend: my-container-api per myapi-hq/internal/routes/container/. Phase 1
+// is metadata + scoped API key issuance; the Cloud Run build/deploy pipeline
+// is Phase 2 — `deployContainer` returns RUNTIME_UNAVAILABLE until it lands.
+export const EXPOSES: Exposes = [
+  'POST /container/orgs/{org_id}/containers',
+  'GET /container/orgs/{org_id}/containers',
+  'GET /container/orgs/{org_id}/containers/{id}',
+  'DELETE /container/orgs/{org_id}/containers/{id}',
+  'POST /container/orgs/{org_id}/containers/{id}/deploy',
+  'GET /container/orgs/{org_id}/containers/{id}/logs',
+];
+
+// service = HTTP server, worker = always-on background process, job = runs
+// to completion (the only type that accepts a cron_schedule).
+export type ContainerType = 'service' | 'worker' | 'job';
+
+// Mirrors the backend's `Container` struct in crud.go. `url` is empty until
+// the container is deployed.
+export interface Container {
+  id: string;
+  org_id: string;
+  name: string;
+  type: ContainerType;
+  cron_schedule?: string;
+  env: Record<string, unknown>;
+  cpu: string;
+  memory: string;
+  min_instances: number;
+  max_instances: number;
+  port: number;
+  url?: string;
+  status: string;
+  created_at: string;
+  updated_at: string;
+}
+
+export interface CreatePayload {
+  name: string;                  // required; ^[a-z0-9][a-z0-9-]{0,49}$
+  type?: ContainerType;          // defaults to 'service' server-side
+  cron_schedule?: string;        // only valid when type is 'job'
+  env?: Record<string, unknown>;
+  cpu?: string;                  // defaults to '1'
+  memory?: string;               // defaults to '512Mi'
+  min_instances?: number;        // defaults to 0 ('worker' is forced to >= 1)
+  max_instances?: number;        // defaults to 3
+  port?: number;
+}
+
+// POST response — the scoped API key is returned ONCE. It is delivered to
+// the running container as the MYAPI_KEY environment variable.
+export interface CreateResponse {
+  container: Container;
+  scoped_api_key: string;
+  scoped_api_key_id: string;
+}
+
+// deployContainer response. The scoped key is ROTATED on every deploy — the
+// value here is fresh and the only time it is knowable.
+export interface DeployResponse {
+  container_id: string;
+  revision_id: string;
+  url: string;
+  status: string;
+  scoped_api_key: string;
+}
+
+export async function createContainer(apiKey: string, orgId: string, payload: CreatePayload): Promise<CreateResponse> {
+  return request('POST', `${BASE_URL}/container/orgs/${encodeURIComponent(orgId)}/containers`, apiKey, payload);
+}
+
+export async function listContainers(apiKey: string, orgId: string): Promise<Container[]> {
+  return request('GET', `${BASE_URL}/container/orgs/${encodeURIComponent(orgId)}/containers`, apiKey);
+}
+
+export async function getContainer(apiKey: string, orgId: string, containerId: string): Promise<Container> {
+  return request('GET', `${BASE_URL}/container/orgs/${encodeURIComponent(orgId)}/containers/${encodeURIComponent(containerId)}`, apiKey);
+}
+
+export async function deleteContainer(apiKey: string, orgId: string, containerId: string): Promise<void> {
+  return request('DELETE', `${BASE_URL}/container/orgs/${encodeURIComponent(orgId)}/containers/${encodeURIComponent(containerId)}`, apiKey);
+}
+
+// deployContainer ships a revision from a pre-built image ref to Cloud Run
+// (source builds land in a later backend slice). Rotates the scoped key.
+export async function deployContainer(apiKey: string, orgId: string, containerId: string, image: string): Promise<DeployResponse> {
+  return request('POST', `${BASE_URL}/container/orgs/${encodeURIComponent(orgId)}/containers/${encodeURIComponent(containerId)}/deploy`, apiKey, { image });
+}
+
+// One runtime log line from the container's Cloud Run resource.
+export interface LogEntry {
+  timestamp: string;
+  severity: string;
+  text: string;
+}
+
+// getContainerLogs returns recent runtime log entries, newest first.
+// `tail` caps the count (default 100, max 1000 server-side). An
+// undeployed container returns an empty array.
+export async function getContainerLogs(apiKey: string, orgId: string, containerId: string, tail?: number): Promise<LogEntry[]> {
+  const query = tail ? `?tail=${encodeURIComponent(String(tail))}` : '';
+  return request('GET', `${BASE_URL}/container/orgs/${encodeURIComponent(orgId)}/containers/${encodeURIComponent(containerId)}/logs${query}`, apiKey);
+}

package/src/hq.ts

@@ -24,6 +24,7 @@ export const EXPOSES: Exposes = [
   'POST /hq/org-imports/{import_id}/confirm',
   'GET /hq/billing/balance',
   'GET /hq/billing/history',
+  'GET /hq/billing/usage',
   'POST /hq/billing/setup-payment',
   'POST /hq/billing/topup',
 ];
@@ -233,6 +234,29 @@ export async function getBillingHistory(apiKey: string): Promise<{ type: string;
   return request('GET', `${BASE_URL}/hq/billing/history`, apiKey);
 }
 
+// One service's rolled-up spend over the usage window.
+export interface ServiceUsage {
+  service: string;
+  requests: number;
+  cost_display: string;
+}
+
+// Spend rolled up by service — the accurate "where is my money going" view.
+// Aggregates every billing event, unlike the flat/capped history log.
+export interface BillingUsage {
+  period: 'month' | '30d';
+  since: string;
+  services: ServiceUsage[];
+  total_display: string;
+}
+
+// getBillingUsage rolls up spend by service for a window: the current
+// calendar month (default) or the trailing 30 days ('30d').
+export async function getBillingUsage(apiKey: string, period?: 'month' | '30d'): Promise<BillingUsage> {
+  const query = period ? `?period=${encodeURIComponent(period)}` : '';
+  return request('GET', `${BASE_URL}/hq/billing/usage${query}`, apiKey);
+}
+
 export async function setupPayment(apiKey: string): Promise<{ url: string }> {
   return request('POST', `${BASE_URL}/hq/billing/setup-payment`, apiKey);
 }

package/src/index.ts

@@ -24,3 +24,4 @@ export * as database from './database';
 export * as crm from './crm';
 export * as fn from './function';
 export * as payments from './payments';
+export * as container from './container';

package/src/services.ts

@@ -171,7 +171,9 @@ export const SERVICES: readonly ServiceMeta[] = [
   {
     module: 'crm',
     skill: 'my-crm-api',
-    domain: 'mycrmapi.com',
+    // Brand domain — mycrmapi.com was unavailable; mypipelineapi.com chosen
+    // and acquired. (Skill stays my-crm-api — domain/skill mismatch accepted.)
+    domain: 'mypipelineapi.com',
     description: 'The canonical store of engaged people + companies. Auto-ingest from inbound webhooks (configurable dot-path). Fixed lifecycle_stage enum, soft delete, event timeline.',
     category: 'data',
     status: 'ga',
@@ -248,4 +250,20 @@ export const SERVICES: readonly ServiceMeta[] = [
     status: 'preview',
     keywords: k('payments', 'stripe', 'checkout', 'billing', 'subscription'),
   },
+  {
+    // CLI top-level command + SDK namespace are both `container`; skill
+    // directory is `my-container-api`.
+    //
+    // Backend status: Phase 1 shipped (metadata + scoped API key). The
+    // Cloud Run build/deploy pipeline is Phase 2 — deploy returns
+    // RUNTIME_UNAVAILABLE until it lands. 'preview' reflects "usable
+    // surface, deploy not yet GA."
+    module: 'container',
+    skill: 'my-container-api',
+    domain: 'mycontainerapi.com',
+    description: 'Run containers on demand — long-running services, background workers, and scheduled jobs. The heavier-duty sibling of edge functions, for native deps and long execution.',
+    category: 'compute',
+    status: 'preview',
+    keywords: k('container', 'cloud-run', 'service', 'worker', 'job'),
+  },
 ] as const;