shipos 0.1.0

package/dist/react/provider.d.ts

@@ -0,0 +1,61 @@
+import { type ReactNode } from "react";
+import { ShipOS, type ShipOSConfig, type FlagsResponse, type CustomerInfo, type SignInOptions } from "../index";
+/**
+ * ShipOS Context Value
+ */
+interface ShipOSContextValue {
+    /** The ShipOS client instance */
+    client: ShipOS;
+    /** All feature flags (cached) */
+    flags: FlagsResponse;
+    /** Whether flags are currently loading */
+    isLoading: boolean;
+    /** Error if flags failed to load */
+    error: Error | null;
+    /** Refresh flags from the API */
+    refreshFlags: () => Promise<void>;
+    /** Current signed-in customer */
+    customer: CustomerInfo | null;
+    /** Sign in a customer */
+    signIn: (options: SignInOptions) => Promise<CustomerInfo>;
+    /** Sign out the current customer */
+    signOut: () => void;
+}
+/**
+ * ShipOS Provider Props
+ */
+interface ShipOSProviderProps {
+    /** ShipOS configuration */
+    config: ShipOSConfig;
+    /** Child components */
+    children: ReactNode;
+    /** Initial flags (for SSR) */
+    initialFlags?: FlagsResponse;
+}
+/**
+ * ShipOS Provider
+ *
+ * Provides the ShipOS client, flags, and customer context to all child components.
+ *
+ * @example
+ * ```tsx
+ * import { ShipOSProvider } from '@shipos/sdk/react';
+ *
+ * function App() {
+ *   return (
+ *     <ShipOSProvider config={{ apiKey: 'your-api-key' }}>
+ *       <YourApp />
+ *     </ShipOSProvider>
+ *   );
+ * }
+ * ```
+ */
+export declare function ShipOSProvider({ config, children, initialFlags, }: ShipOSProviderProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * Hook to access the ShipOS context
+ *
+ * @throws Error if used outside of ShipOSProvider
+ */
+export declare function useShipOS(): ShipOSContextValue;
+export {};
+//# sourceMappingURL=provider.d.ts.map

package/dist/react/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/react/provider.tsx"],"names":[],"mappings":"AAEA,OAAO,EAML,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AACf,OAAO,EACL,MAAM,EACN,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,aAAa,EACnB,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,UAAU,kBAAkB;IAC1B,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,KAAK,EAAE,aAAa,CAAC;IACrB,0CAA0C;IAC1C,SAAS,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,iCAAiC;IACjC,YAAY,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,iCAAiC;IACjC,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC;IAC9B,yBAAyB;IACzB,MAAM,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,YAAY,CAAC,CAAC;IAC1D,oCAAoC;IACpC,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAID;;GAEG;AACH,UAAU,mBAAmB;IAC3B,2BAA2B;IAC3B,MAAM,EAAE,YAAY,CAAC;IACrB,uBAAuB;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,8BAA8B;IAC9B,YAAY,CAAC,EAAE,aAAa,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,CAAC,EAC7B,MAAM,EACN,QAAQ,EACR,YAAiB,GAClB,EAAE,mBAAmB,2CAqErB;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,kBAAkB,CAM9C"}

package/dist/types.d.ts

@@ -0,0 +1,69 @@
+/**
+ * ShipOS SDK Types
+ */
+/**
+ * Configuration options for the ShipOS client
+ */
+export interface ShipOSConfig {
+    /** Your ShipOS API key */
+    apiKey: string;
+    /** Base URL for the ShipOS API (defaults to production) */
+    baseUrl?: string;
+    /** Environment to fetch flags/configs for (defaults to 'production') */
+    environment?: string;
+    /** Cache TTL in milliseconds (defaults to 60000 - 1 minute) */
+    cacheTTL?: number;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * Feature flags response type
+ */
+export type FlagsResponse = Record<string, boolean>;
+/**
+ * Config response type (generic for typed configs)
+ */
+export type ConfigResponse<T = Record<string, unknown>> = T;
+/**
+ * API error response
+ */
+export interface ApiError {
+    error: string;
+    code?: string;
+}
+/**
+ * Cache entry with timestamp
+ */
+export interface CacheEntry<T> {
+    data: T;
+    timestamp: number;
+}
+/**
+ * Result type for async operations
+ */
+export type Result<T, E = Error> = {
+    success: true;
+    data: T;
+} | {
+    success: false;
+    error: E;
+};
+/**
+ * Customer information returned after sign-in
+ */
+export interface CustomerInfo {
+    /** External ID used to identify the customer */
+    externalId: string;
+    /** Optional metadata associated with the customer */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Options for signing in a customer
+ */
+export interface SignInOptions {
+    /** External ID used to identify the customer in your system */
+    externalId: string;
+    /** Optional JSON metadata to associate with the customer */
+    metadata?: Record<string, unknown>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wEAAwE;IACxE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,IAAI,EAAE,CAAC,CAAC;IACR,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,IAC3B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,CAAA;CAAE,GAC1B;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,UAAU,EAAE,MAAM,CAAC;IACnB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "shipos",
+  "version": "0.1.0",
+  "description": "ShipOS SDK for feature flags and global configs",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./react": {
+      "import": "./dist/react/index.js",
+      "types": "./dist/react/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "bun build ./src/index.ts ./src/react/index.ts --outdir ./dist --target browser --format esm --external react && bun run build:types",
+    "build:types": "tsc --emitDeclarationOnly --declaration --outDir ./dist",
+    "dev": "bun run build --watch",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "bun run build"
+  },
+  "keywords": [
+    "shipos",
+    "feature-flags",
+    "config",
+    "sdk",
+    "react"
+  ],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/react": "^19.0.0"
+  },
+  "peerDependencies": {
+    "react": "^18 || ^19",
+    "typescript": "^5"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  }
+}