@thyn-ai/sqai 0.1.3 → 0.1.5

package/dist/index.d.cts

@@ -235,12 +235,14 @@ declare class RuntimeProvisioner {
 
 /** Contract-derived wire value: everything the computation plane can
  * transport. The wire schema transports; the capability contract authorizes. */
-type AlgentaWireValue = null | boolean | number | string | AlgentaWireValue[] | {
-    [key: string]: AlgentaWireValue;
+type SqaiValue = null | boolean | number | string | SqaiValue[] | {
+    [key: string]: SqaiValue;
 } | {
     type: "decimal" | "bigint";
     value: string;
 };
+/** @deprecated Renamed to {@link SqaiValue}. Kept as a non-breaking alias. */
+type AlgentaWireValue = SqaiValue;
 interface SqaiSource {
     name: string;
     source_id: string | null;
@@ -291,8 +293,8 @@ type ComputationBinding = {
 interface ComputationSpec {
     module: string;
     function: string;
-    args?: AlgentaWireValue[];
-    kwargs?: Record<string, AlgentaWireValue>;
+    args?: SqaiValue[];
+    kwargs?: Record<string, SqaiValue>;
     bindings?: ComputationBinding[];
     seed?: number | string;
 }
@@ -325,7 +327,7 @@ interface BindingProvenance {
 }
 interface ComputeResult {
     status: "ok";
-    value: AlgentaWireValue;
+    value: SqaiValue;
     value_type: string;
     module: string;
     function: string;
@@ -485,11 +487,11 @@ declare function createSQAI(config?: SqaiConfig): SQAI;
 
 /** SQAI failure contract.
  *
- * Algenta error codes pass through verbatim (`source: "algenta"`); SQAI adds
+ * Algenta error codes pass through verbatim (`source: "engine"`); SQAI adds
  * its own codes in the same snake_case vocabulary (`source: "sqai"`). A code
  * is never renamed and the same condition never gets two codes.
  */
-type SqaiErrorSource = "algenta" | "sqai";
+type SqaiErrorSource = "engine" | "sqai";
 interface SqaiErrorOptions {
     retryable?: boolean;
     requestId?: string | null;
@@ -532,8 +534,8 @@ declare const SQAI_ERROR_CODES: readonly ["unsupported_operation", "seed_require
 interface InvocationIdentity {
     module: string;
     function: string;
-    args: AlgentaWireValue[];
-    kwargs: Record<string, AlgentaWireValue>;
+    args: SqaiValue[];
+    kwargs: Record<string, SqaiValue>;
     resolved_bindings: Array<{
         parameter: string | number;
         source_name: string;
@@ -573,6 +575,36 @@ declare class ResultStore {
     private evictOldestForTenant;
 }
 
+/**
+ * `sqai login` — device onboarding for the SQAI runtime (JS/TS side; mirrors the Python sqai._login).
+ *
+ * Authenticates via the shared accounts portal (OAuth 2.0 device grant, RFC 8628), resolves-or-creates
+ * the caller's org on the free `sqai_developer` tier, and mints a control-plane API key. The key is
+ * cached under ~/.sqai and handed to the local runtime daemon (as ALGENTA_API_KEY), which exchanges it
+ * once for a platform-signed, device-bound offline license — then everything runs locally, no query-time
+ * network. Same device tech telys/algenta use; only the product literals differ.
+ *
+ * Free forever on 1 machine. Paid tiers (sqai_pro / sqai_team) add devices/seats/commercial use via the
+ * accounts billing portal — never a cloud service. Login is licensing-only; no data leaves the machine.
+ */
+declare class LoginError extends Error {
+}
+declare function sqaiHome(): string;
+/** Resolve the SQAI API key for the runtime: $SQAI_API_KEY / $ALGENTA_API_KEY, else the cached key. */
+declare function readCachedApiKey(): Promise<string | undefined>;
+interface LoginResult {
+    device_id: string;
+    plan: string;
+    api_key_prefix: string;
+}
+declare function login(opts?: {
+    plan?: string;
+    accessToken?: string;
+    openBrowser?: boolean;
+}): Promise<LoginResult>;
+/** Remove cached token + API key (keeps the device identity so a re-login rebinds the same device). */
+declare function logout(): void;
+
 /** Computation-plane validation: dynamic, against the embedded capability
  * contract. The zod wire schema (in @thyn-ai/sqai-ai-sdk) only transports values;
  * everything here authorizes them. SQAI computes nothing — a validated
@@ -586,17 +618,17 @@ declare class ResultStore {
 
 interface ResolvedBindingValue {
     parameter: string | number;
-    values: AlgentaWireValue;
+    values: SqaiValue;
     provenance: BindingProvenance;
 }
 interface ValidatedComputation {
     entry: CapabilityEntry;
     /** Final positional argument vector, ordered by the signature params. */
-    argsVector: AlgentaWireValue[];
+    argsVector: SqaiValue[];
     seed: number | string | null;
     bindings: ResolvedBindingValue[];
 }
 declare function lookupCapability(index: ContractIndex, module: string, functionName: string): CapabilityEntry;
 declare function validateComputation(spec: ComputationSpec, index: ContractIndex, policy: SqaiPolicy | undefined, resolvedBindings: ResolvedBindingValue[]): ValidatedComputation;
 
-export { type AlgentaWireValue, type AskOutcome, type BindingProvenance, type CapabilityContract, type CapabilityEntry, type CapabilityMatch, type ColumnExtract, type ComputationBinding, type ComputationSpec, type ComputeResult, ContractIndex, type DeterminismEnvelope, type InvocationIdentity, type QueryFilterCondition, type QueryFilterSpec, type QuerySpec, type ResolvedBindingValue, ResultStore, type ResultStoreConfig, RuntimeProvisioner, type RuntimeStatus, SQAI, SQAI_ERROR_CODES, type SqaiConfig, SqaiError, type SqaiErrorSource, type SqaiIntent, type SqaiOutcome, type SqaiPolicy, type SqaiResultRecord, type SqaiSource, type ValidatedComputation, computationHash, createSQAI, currentPlatformKey, invocationHash, isReadOnlyEligible, lookupCapability, runtimeCacheDir, validateComputation };
+export { type AlgentaWireValue, type AskOutcome, type BindingProvenance, type CapabilityContract, type CapabilityEntry, type CapabilityMatch, type ColumnExtract, type ComputationBinding, type ComputationSpec, type ComputeResult, ContractIndex, type DeterminismEnvelope, type InvocationIdentity, LoginError, type LoginResult, type QueryFilterCondition, type QueryFilterSpec, type QuerySpec, type ResolvedBindingValue, ResultStore, type ResultStoreConfig, RuntimeProvisioner, type RuntimeStatus, SQAI, SQAI_ERROR_CODES, type SqaiConfig, SqaiError, type SqaiErrorSource, type SqaiIntent, type SqaiOutcome, type SqaiPolicy, type SqaiResultRecord, type SqaiSource, type SqaiValue, type ValidatedComputation, computationHash, createSQAI, currentPlatformKey, invocationHash, isReadOnlyEligible, login, logout, lookupCapability, readCachedApiKey, runtimeCacheDir, sqaiHome, validateComputation };

package/dist/index.d.ts

@@ -235,12 +235,14 @@ declare class RuntimeProvisioner {
 
 /** Contract-derived wire value: everything the computation plane can
  * transport. The wire schema transports; the capability contract authorizes. */
-type AlgentaWireValue = null | boolean | number | string | AlgentaWireValue[] | {
-    [key: string]: AlgentaWireValue;
+type SqaiValue = null | boolean | number | string | SqaiValue[] | {
+    [key: string]: SqaiValue;
 } | {
     type: "decimal" | "bigint";
     value: string;
 };
+/** @deprecated Renamed to {@link SqaiValue}. Kept as a non-breaking alias. */
+type AlgentaWireValue = SqaiValue;
 interface SqaiSource {
     name: string;
     source_id: string | null;
@@ -291,8 +293,8 @@ type ComputationBinding = {
 interface ComputationSpec {
     module: string;
     function: string;
-    args?: AlgentaWireValue[];
-    kwargs?: Record<string, AlgentaWireValue>;
+    args?: SqaiValue[];
+    kwargs?: Record<string, SqaiValue>;
     bindings?: ComputationBinding[];
     seed?: number | string;
 }
@@ -325,7 +327,7 @@ interface BindingProvenance {
 }
 interface ComputeResult {
     status: "ok";
-    value: AlgentaWireValue;
+    value: SqaiValue;
     value_type: string;
     module: string;
     function: string;
@@ -485,11 +487,11 @@ declare function createSQAI(config?: SqaiConfig): SQAI;
 
 /** SQAI failure contract.
  *
- * Algenta error codes pass through verbatim (`source: "algenta"`); SQAI adds
+ * Algenta error codes pass through verbatim (`source: "engine"`); SQAI adds
  * its own codes in the same snake_case vocabulary (`source: "sqai"`). A code
  * is never renamed and the same condition never gets two codes.
  */
-type SqaiErrorSource = "algenta" | "sqai";
+type SqaiErrorSource = "engine" | "sqai";
 interface SqaiErrorOptions {
     retryable?: boolean;
     requestId?: string | null;
@@ -532,8 +534,8 @@ declare const SQAI_ERROR_CODES: readonly ["unsupported_operation", "seed_require
 interface InvocationIdentity {
     module: string;
     function: string;
-    args: AlgentaWireValue[];
-    kwargs: Record<string, AlgentaWireValue>;
+    args: SqaiValue[];
+    kwargs: Record<string, SqaiValue>;
     resolved_bindings: Array<{
         parameter: string | number;
         source_name: string;
@@ -573,6 +575,36 @@ declare class ResultStore {
     private evictOldestForTenant;
 }
 
+/**
+ * `sqai login` — device onboarding for the SQAI runtime (JS/TS side; mirrors the Python sqai._login).
+ *
+ * Authenticates via the shared accounts portal (OAuth 2.0 device grant, RFC 8628), resolves-or-creates
+ * the caller's org on the free `sqai_developer` tier, and mints a control-plane API key. The key is
+ * cached under ~/.sqai and handed to the local runtime daemon (as ALGENTA_API_KEY), which exchanges it
+ * once for a platform-signed, device-bound offline license — then everything runs locally, no query-time
+ * network. Same device tech telys/algenta use; only the product literals differ.
+ *
+ * Free forever on 1 machine. Paid tiers (sqai_pro / sqai_team) add devices/seats/commercial use via the
+ * accounts billing portal — never a cloud service. Login is licensing-only; no data leaves the machine.
+ */
+declare class LoginError extends Error {
+}
+declare function sqaiHome(): string;
+/** Resolve the SQAI API key for the runtime: $SQAI_API_KEY / $ALGENTA_API_KEY, else the cached key. */
+declare function readCachedApiKey(): Promise<string | undefined>;
+interface LoginResult {
+    device_id: string;
+    plan: string;
+    api_key_prefix: string;
+}
+declare function login(opts?: {
+    plan?: string;
+    accessToken?: string;
+    openBrowser?: boolean;
+}): Promise<LoginResult>;
+/** Remove cached token + API key (keeps the device identity so a re-login rebinds the same device). */
+declare function logout(): void;
+
 /** Computation-plane validation: dynamic, against the embedded capability
  * contract. The zod wire schema (in @thyn-ai/sqai-ai-sdk) only transports values;
  * everything here authorizes them. SQAI computes nothing — a validated
@@ -586,17 +618,17 @@ declare class ResultStore {
 
 interface ResolvedBindingValue {
     parameter: string | number;
-    values: AlgentaWireValue;
+    values: SqaiValue;
     provenance: BindingProvenance;
 }
 interface ValidatedComputation {
     entry: CapabilityEntry;
     /** Final positional argument vector, ordered by the signature params. */
-    argsVector: AlgentaWireValue[];
+    argsVector: SqaiValue[];
     seed: number | string | null;
     bindings: ResolvedBindingValue[];
 }
 declare function lookupCapability(index: ContractIndex, module: string, functionName: string): CapabilityEntry;
 declare function validateComputation(spec: ComputationSpec, index: ContractIndex, policy: SqaiPolicy | undefined, resolvedBindings: ResolvedBindingValue[]): ValidatedComputation;
 
-export { type AlgentaWireValue, type AskOutcome, type BindingProvenance, type CapabilityContract, type CapabilityEntry, type CapabilityMatch, type ColumnExtract, type ComputationBinding, type ComputationSpec, type ComputeResult, ContractIndex, type DeterminismEnvelope, type InvocationIdentity, type QueryFilterCondition, type QueryFilterSpec, type QuerySpec, type ResolvedBindingValue, ResultStore, type ResultStoreConfig, RuntimeProvisioner, type RuntimeStatus, SQAI, SQAI_ERROR_CODES, type SqaiConfig, SqaiError, type SqaiErrorSource, type SqaiIntent, type SqaiOutcome, type SqaiPolicy, type SqaiResultRecord, type SqaiSource, type ValidatedComputation, computationHash, createSQAI, currentPlatformKey, invocationHash, isReadOnlyEligible, lookupCapability, runtimeCacheDir, validateComputation };
+export { type AlgentaWireValue, type AskOutcome, type BindingProvenance, type CapabilityContract, type CapabilityEntry, type CapabilityMatch, type ColumnExtract, type ComputationBinding, type ComputationSpec, type ComputeResult, ContractIndex, type DeterminismEnvelope, type InvocationIdentity, LoginError, type LoginResult, type QueryFilterCondition, type QueryFilterSpec, type QuerySpec, type ResolvedBindingValue, ResultStore, type ResultStoreConfig, RuntimeProvisioner, type RuntimeStatus, SQAI, SQAI_ERROR_CODES, type SqaiConfig, SqaiError, type SqaiErrorSource, type SqaiIntent, type SqaiOutcome, type SqaiPolicy, type SqaiResultRecord, type SqaiSource, type SqaiValue, type ValidatedComputation, computationHash, createSQAI, currentPlatformKey, invocationHash, isReadOnlyEligible, login, logout, lookupCapability, readCachedApiKey, runtimeCacheDir, sqaiHome, validateComputation };