@omnibase/core-js 0.8.0 → 0.9.0

package/docs/V1StripeConfigResponse.md

@@ -0,0 +1,42 @@
+
+# V1StripeConfigResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`config` | [ModelsStripeConfigurationWithIDs](ModelsStripeConfigurationWithIDs.md)
+`createdAt` | string
+`id` | string
+`updatedAt` | string
+`version` | string
+
+## Example
+
+```typescript
+import type { V1StripeConfigResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "config": null,
+  "createdAt": 2024-01-01T00:00:00Z,
+  "id": 123e4567-e89b-12d3-a456-426614174000,
+  "updatedAt": 2024-01-01T00:00:00Z,
+  "version": 1.0.0,
+} satisfies V1StripeConfigResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V1StripeConfigResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V1SubjectSetRequest.md

@@ -0,0 +1,38 @@
+
+# V1SubjectSetRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`namespace` | string
+`object` | string
+`relation` | string
+
+## Example
+
+```typescript
+import type { V1SubjectSetRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "namespace": Tenant,
+  "object": tenant-123,
+  "relation": member,
+} satisfies V1SubjectSetRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as V1SubjectSetRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,72 +1,21 @@
 {
   "name": "@omnibase/core-js",
-  "version": "0.8.0",
-  "description": "OmniBase core Javascript SDK - framework agnostic",
-  "files": [
-    "dist/**/*"
-  ],
-  "type": "module",
-  "scripts": {
-    "build": "tsup src/index.ts src/permissions/index.ts src/database/index.ts src/tenants/index.ts src/auth/index.ts src/payments/index.ts src/storage/index.ts --format cjs,esm --dts",
-    "prepublishOnly": "npm run build"
+  "version": "0.9.0",
+  "description": "OpenAPI client for @omnibase/core-js",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
   },
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    },
-    "./auth": {
-      "types": "./dist/auth/index.d.ts"
-    },
-    "./permissions": {
-      "types": "./dist/permissions/index.d.ts",
-      "import": "./dist/permissions/index.js",
-      "require": "./dist/permissions/index.cjs"
-    },
-    "./database": {
-      "types": "./dist/database/index.d.ts",
-      "import": "./dist/database/index.js",
-      "require": "./dist/database/index.cjs"
-    },
-    "./tenants": {
-      "types": "./dist/tenants/index.d.ts",
-      "import": "./dist/tenants/index.js",
-      "require": "./dist/tenants/index.cjs"
-    },
-    "./payments": {
-      "types": "./dist/payments/index.d.ts",
-      "import": "./dist/payments/index.js",
-      "require": "./dist/payments/index.cjs"
-    },
-    "./storage": {
-      "types": "./dist/storage/index.d.ts",
-      "import": "./dist/storage/index.js",
-      "require": "./dist/storage/index.cjs"
-    }
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
   },
-  "keywords": [
-    "omnibase",
-    "sdk",
-    "javascript",
-    "typescript"
-  ],
-  "author": "Phoenix Baker Van Urk",
-  "license": "MIT",
   "devDependencies": {
-    "@types/bun": "latest",
-    "docusaurus-plugin-typedoc": "^1.4.2",
-    "tsup": "^8.5.0",
-    "typedoc": "^0.28.13",
-    "typedoc-github-wiki-theme": "^2.1.0",
-    "typedoc-plugin-markdown": "^4.9.0"
-  },
-  "peerDependencies": {
-    "typescript": "^5.9.2"
-  },
-  "dependencies": {
-    "@ory/client": "^1.22.3",
-    "@ory/client-fetch": "^1.22.2",
-    "@supabase/postgrest-js": "^1.21.4"
+    "typescript": "^4.0 || ^5.0"
   }
 }

package/src/apis/DatabaseApi.ts

@@ -0,0 +1,106 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Omnibase REST API
+ * Self-hostable Backend-as-a-Service providing database management, authentication, payments, storage, and email services.  ## Features - **Database**: PostgreSQL with RLS and migrations - **Authentication**: Ory Kratos integration with session management - **Payments**: Stripe integration with version-controlled billing configs - **Storage**: S3-compatible object storage with RLS - **Email**: Transactional email service - **Permissions**: Fine-grained access control via Ory Keto  ## Authentication Most endpoints require authentication via session cookies or JWT tokens. Use the appropriate security scheme based on the endpoint requirements.
+ *
+ * The version of the OpenAPI document: 0.9.0
+ * Contact: support@omnibase.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  HandlersInternalServerErrorResponse,
+  HandlersUnauthorizedResponse,
+  V1MigrationErrorResponse,
+  V1MigrationSuccessResponse,
+} from '../models/index';
+import {
+    HandlersInternalServerErrorResponseFromJSON,
+    HandlersInternalServerErrorResponseToJSON,
+    HandlersUnauthorizedResponseFromJSON,
+    HandlersUnauthorizedResponseToJSON,
+    V1MigrationErrorResponseFromJSON,
+    V1MigrationErrorResponseToJSON,
+    V1MigrationSuccessResponseFromJSON,
+    V1MigrationSuccessResponseToJSON,
+} from '../models/index';
+
+export interface UploadDatabaseMigrationsRequest {
+    migrations: Blob;
+}
+
+/**
+ * 
+ */
+export class DatabaseApi extends runtime.BaseAPI {
+
+    /**
+     * Uploads SQL migration files and applies them to the user\'s PostgreSQL database.  ## Authentication Requires JWT token (typically used by CLI tools, not browser sessions).  ## Migration Format Upload a zip file containing SQL files named like: `001-seed.sql`, `002-rls.sql`, etc. Files are automatically renamed to golang-migrate format: `001_seed.up.sql`, `002_rls.up.sql`.  ## Use Cases - CLI migration uploads via `omnibase db migration push` - CI/CD pipeline integrations - Programmatic schema management
+     * Upload database migrations
+     */
+    async uploadDatabaseMigrationsRaw(requestParameters: UploadDatabaseMigrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V1MigrationSuccessResponse>> {
+        if (requestParameters['migrations'] == null) {
+            throw new runtime.RequiredError(
+                'migrations',
+                'Required parameter "migrations" was null or undefined when calling uploadDatabaseMigrations().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // BearerAuth authentication
+        }
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['migrations'] != null) {
+            formParams.append('migrations', requestParameters['migrations'] as any);
+        }
+
+
+        let urlPath = `/database/migrations`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => V1MigrationSuccessResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Uploads SQL migration files and applies them to the user\'s PostgreSQL database.  ## Authentication Requires JWT token (typically used by CLI tools, not browser sessions).  ## Migration Format Upload a zip file containing SQL files named like: `001-seed.sql`, `002-rls.sql`, etc. Files are automatically renamed to golang-migrate format: `001_seed.up.sql`, `002_rls.up.sql`.  ## Use Cases - CLI migration uploads via `omnibase db migration push` - CI/CD pipeline integrations - Programmatic schema management
+     * Upload database migrations
+     */
+    async uploadDatabaseMigrations(requestParameters: UploadDatabaseMigrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V1MigrationSuccessResponse> {
+        const response = await this.uploadDatabaseMigrationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/PaymentsApi.ts

@@ -0,0 +1,201 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Omnibase REST API
+ * Self-hostable Backend-as-a-Service providing database management, authentication, payments, storage, and email services.  ## Features - **Database**: PostgreSQL with RLS and migrations - **Authentication**: Ory Kratos integration with session management - **Payments**: Stripe integration with version-controlled billing configs - **Storage**: S3-compatible object storage with RLS - **Email**: Transactional email service - **Permissions**: Fine-grained access control via Ory Keto  ## Authentication Most endpoints require authentication via session cookies or JWT tokens. Use the appropriate security scheme based on the endpoint requirements.
+ *
+ * The version of the OpenAPI document: 0.9.0
+ * Contact: support@omnibase.dev
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  CreateCheckout200Response,
+  CreateCustomerPortal200Response,
+  HandlersBadRequestResponse,
+  HandlersInternalServerErrorResponse,
+  HandlersSuccessResponse,
+  HandlersUnauthorizedResponse,
+  V1CreateCheckoutRequest,
+  V1CreatePortalRequest,
+  V1RecordUsageRequest,
+} from '../models/index';
+import {
+    CreateCheckout200ResponseFromJSON,
+    CreateCheckout200ResponseToJSON,
+    CreateCustomerPortal200ResponseFromJSON,
+    CreateCustomerPortal200ResponseToJSON,
+    HandlersBadRequestResponseFromJSON,
+    HandlersBadRequestResponseToJSON,
+    HandlersInternalServerErrorResponseFromJSON,
+    HandlersInternalServerErrorResponseToJSON,
+    HandlersSuccessResponseFromJSON,
+    HandlersSuccessResponseToJSON,
+    HandlersUnauthorizedResponseFromJSON,
+    HandlersUnauthorizedResponseToJSON,
+    V1CreateCheckoutRequestFromJSON,
+    V1CreateCheckoutRequestToJSON,
+    V1CreatePortalRequestFromJSON,
+    V1CreatePortalRequestToJSON,
+    V1RecordUsageRequestFromJSON,
+    V1RecordUsageRequestToJSON,
+} from '../models/index';
+
+export interface CreateCheckoutRequest {
+    request: V1CreateCheckoutRequest;
+}
+
+export interface CreateCustomerPortalRequest {
+    request: V1CreatePortalRequest;
+}
+
+export interface RecordUsageRequest {
+    request: V1RecordUsageRequest;
+}
+
+/**
+ * 
+ */
+export class PaymentsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates a Stripe Checkout Session for the specified price ID. The session URL can be used to redirect users to complete payment.  ## Authentication Requires JWT token. If the user has an existing Stripe customer ID, it will be used; otherwise, a new customer will be created.  ## Use Cases - Subscription sign-ups - One-time purchases - Trial period checkouts - Promotional code redemption
+     * Create checkout session
+     */
+    async createCheckoutRaw(requestParameters: CreateCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCheckout200Response>> {
+        if (requestParameters['request'] == null) {
+            throw new runtime.RequiredError(
+                'request',
+                'Required parameter "request" was null or undefined when calling createCheckout().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // BearerAuth authentication
+        }
+
+
+        let urlPath = `/payments/checkout`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: V1CreateCheckoutRequestToJSON(requestParameters['request']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateCheckout200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Creates a Stripe Checkout Session for the specified price ID. The session URL can be used to redirect users to complete payment.  ## Authentication Requires JWT token. If the user has an existing Stripe customer ID, it will be used; otherwise, a new customer will be created.  ## Use Cases - Subscription sign-ups - One-time purchases - Trial period checkouts - Promotional code redemption
+     * Create checkout session
+     */
+    async createCheckout(requestParameters: CreateCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCheckout200Response> {
+        const response = await this.createCheckoutRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates a Stripe Customer Portal session where users can manage their subscription, payment methods, and billing history.  ## Authentication Requires JWT token and an associated Stripe customer ID.  ## Use Cases - Subscription management - Payment method updates - Invoice history viewing
+     * Create customer portal session
+     */
+    async createCustomerPortalRaw(requestParameters: CreateCustomerPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCustomerPortal200Response>> {
+        if (requestParameters['request'] == null) {
+            throw new runtime.RequiredError(
+                'request',
+                'Required parameter "request" was null or undefined when calling createCustomerPortal().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // BearerAuth authentication
+        }
+
+
+        let urlPath = `/payments/portal`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: V1CreatePortalRequestToJSON(requestParameters['request']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateCustomerPortal200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Creates a Stripe Customer Portal session where users can manage their subscription, payment methods, and billing history.  ## Authentication Requires JWT token and an associated Stripe customer ID.  ## Use Cases - Subscription management - Payment method updates - Invoice history viewing
+     * Create customer portal session
+     */
+    async createCustomerPortal(requestParameters: CreateCustomerPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCustomerPortal200Response> {
+        const response = await this.createCustomerPortalRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Records a usage event for metered billing. The customer must have an active subscription with metered pricing.  ## Authentication Requires JWT token and an associated Stripe customer ID.  ## Use Cases - API request metering - Compute time tracking - Storage usage recording - Any metered billing scenario
+     * Record metered usage
+     */
+    async recordUsageRaw(requestParameters: RecordUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HandlersSuccessResponse>> {
+        if (requestParameters['request'] == null) {
+            throw new runtime.RequiredError(
+                'request',
+                'Required parameter "request" was null or undefined when calling recordUsage().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // BearerAuth authentication
+        }
+
+
+        let urlPath = `/payments/usage`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: V1RecordUsageRequestToJSON(requestParameters['request']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => HandlersSuccessResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Records a usage event for metered billing. The customer must have an active subscription with metered pricing.  ## Authentication Requires JWT token and an associated Stripe customer ID.  ## Use Cases - API request metering - Compute time tracking - Storage usage recording - Any metered billing scenario
+     * Record metered usage
+     */
+    async recordUsage(requestParameters: RecordUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HandlersSuccessResponse> {
+        const response = await this.recordUsageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}