@adspireai/adspire-node-sdk 1.0.0 → 1.0.3

package/README.md

@@ -1 +1,75 @@
-# adspire-sdk-node
+
+# adspire-sdk-node
+
+A Node.js SDK for easily interacting with the [Adspire API](https://api.adspire.ai/docs).
+
+## Features
+
+- Simple, auto-generated TypeScript client for Adspire's REST API
+- Built on top of [`@hey-api/client-fetch`](https://www.npmjs.com/package/@hey-api/client-fetch)
+- Type-safe API calls (via auto-generated types)
+- Easily configurable base URL and environment settings
+
+## Usage
+
+First, set up your environment variable for the OpenAPI spec URL:
+
+1. Copy the example environment file, then edit `.env` as needed:
+
+    ```bash
+    npm run setup
+    ```
+
+    The `.env` file will include:
+    
+    ```
+    OPENAPI_SPEC=https://stage-api.adspire.ai/docs?api-docs.json
+    ```
+
+## Scripts
+
+- `npm run setup` – Copies `env.example` to `.env` for local environment setup.
+- `npm run generate` – Regenerates the SDK from the OpenAPI spec (requires [ts-node](https://typestrong.org/ts-node/)).
+- `npm run build` – Compiles the TypeScript SDK (src/) into publishable JavaScript (dist/src/).
+
+## Installation
+
+```bash
+npm install @adspireai/adspire-node-sdk
+```
+
+## Regenerating SDK
+
+If the API spec changes:
+
+```bash
+npm run generate
+npm run build
+```
+
+This will update the SDK code under `src/` based on the latest OpenAPI spec defined in your `.env` file and dist package that gets published to npmjs.
+
+Note:
+Only the compiled SDK (dist/src/) is published to npm, not the source or script files. If you're contributing or testing locally, use the scripts as above.
+
+## Development
+
+- The SDK is source-based and auto-generated using [`@hey-api/openapi-ts`](https://www.npmjs.com/package/@hey-api/openapi-ts).
+- All TypeScript-generated API types and methods are available via:
+
+    ```typescript
+    import * from '@adspireai/adspire-node-sdk'
+    ```
+
+- See `src/client.gen.ts` and `src/index.ts` for details.
+
+## Contributing
+
+Pull requests welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+---
+
+*Generated by [@hey-api/openapi-ts](https://www.npmjs.com/package/@hey-api/openapi-ts)*
+
+**Explanation:**  
+This `README.md` covers installation, environment setup, usage, available scripts, development workflows, and licensing, matching the project details found in your `package.json`, `env.example`, and source files. For more advanced SDK usage or full API endpoint documentation, you should look into your generated `src/sdk.gen.ts` or the official [Adspire API docs](https://api.adspire.ai/docs).

package/package.json

@@ -1,21 +1,57 @@
 {
   "name": "@adspireai/adspire-node-sdk",
-  "version": "1.0.0",
-  "main": "index.js",
+  "version": "1.0.3",
+  "description": "Official Node.js SDK for AdspireAI API",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist/src"
+  ],
   "scripts": {
     "setup": "cp env.example .env",
-    "generate": "ts-node scripts/generate-sdk.ts"
+    "generate": "ts-node scripts/generate-sdk.ts",
+    "build": "tsc",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"No tests specified\" && exit 0"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "description": "",
+  "keywords": [
+    "adspire",
+    "adspireai",
+    "sdk",
+    "api"
+  ],
+  "author": "AdspireAI",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adspireai/adspire-node-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/adspireai/adspire-node-sdk/issues"
+  },
+  "homepage": "https://github.com/adspireai/adspire-node-sdk#readme",
   "devDependencies": {
     "@hey-api/client-fetch": "^0.12.0",
     "@hey-api/openapi-ts": "^0.71.1",
     "@types/node": "^22.15.30",
+    "@types/semver": "^7.7.0",
     "dotenv": "^16.5.0",
+    "rimraf": "^5.0.10",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "axios": "^1.0.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "semver": "^7.7.2"
   }
 }

package/.github/workflows/generate-sdk.yml

@@ -1,41 +0,0 @@
-name: Generate SDK
-
-on:
-  workflow_dispatch:  # Allow manual triggering
-  schedule:
-    - cron: '0 0 * * 1'  # Weekly on Mondays at midnight
-  # You could also trigger this when your main API repo updates its OpenAPI spec
-
-jobs:
-  generate:
-    runs-on: ubuntu-latest
-    environment: stage
-    steps:
-      - uses: actions/checkout@v3
-      
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: '20'
-          cache: 'npm'
-          registry-url: 'https://registry.npmjs.org'
-      
-      - name: Install dependencies
-        run: npm ci
-      
-      - name: Generate SDK
-        run: npm run generate
-        env:
-          OPENAPI_SPEC: ${{ vars.OPENAPI_SPEC }}
-      
-      - name: Commit changes
-        uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          commit_message: "chore: update SDK from latest OpenAPI spec"
-          branch: main
-
-      - name: Publish to npm
-        if: github.ref == 'refs/heads/main'
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm publish --access public

package/env.example

@@ -1 +0,0 @@
-OPENAPI_SPEC=https://stage-api.adspire.ai/docs?api-docs.json

package/scripts/generate-sdk.ts

@@ -1,17 +0,0 @@
-import 'dotenv/config'
-import { createClient } from '@hey-api/openapi-ts';
-
-async function main() {
-  const specUrl = process.env.OPENAPI_SPEC || ''
-  await createClient({
-    input: specUrl,
-    output: 'src',
-    plugins: ['@hey-api/client-fetch']
-  });
-  console.log('SDK generated from', specUrl);
-}
-
-main().catch((err) => {
-  console.error('Error generating SDK:', err);
-  process.exit(1);
-});

package/src/client.gen.ts

@@ -1,18 +0,0 @@
-// This file is auto-generated by @hey-api/openapi-ts
-
-import type { ClientOptions } from './types.gen';
-import { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';
-
-/**
- * The `createClientConfig()` function will be called on client initialization
- * and the returned object will become the client's initial configuration.
- *
- * You may want to initialize your client this way instead of calling
- * `setConfig()`. This is useful for example if you're using Next.js
- * to ensure your client always has the correct values.
- */
-export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
-
-export const client = createClient(createConfig<ClientOptions>({
-    baseUrl: 'https://stage-api.adspire.ai'
-}));

package/src/index.ts

@@ -1,3 +0,0 @@
-// This file is auto-generated by @hey-api/openapi-ts
-export * from './types.gen';
-export * from './sdk.gen';

package/src/sdk.gen.ts

@@ -1,82 +0,0 @@
-// This file is auto-generated by @hey-api/openapi-ts
-
-import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { RegisterUserData, RegisterUserResponses, RegisterUserErrors, LoginUserData, LoginUserResponses, LoginUserErrors, GetMeData, GetMeResponses, GetMeErrors, LogoutUserData, LogoutUserResponses, LogoutUserErrors, RefreshTokenData, RefreshTokenResponses, RefreshTokenErrors } from './types.gen';
-import { client as _heyApiClient } from './client.gen';
-
-export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
-    /**
-     * You can provide a client instance returned by `createClient()` instead of
-     * individual options. This might be also useful if you want to implement a
-     * custom client.
-     */
-    client?: Client;
-    /**
-     * You can pass arbitrary values through the `meta` object. This can be
-     * used to access values that aren't defined as part of the SDK function.
-     */
-    meta?: Record<string, unknown>;
-};
-
-/**
- * Register a new user
- * Creates a new user account and returns authentication token or success message
- */
-export const registerUser = <ThrowOnError extends boolean = false>(options: Options<RegisterUserData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<RegisterUserResponses, RegisterUserErrors, ThrowOnError>({
-        url: '/api/auth/register',
-        ...options,
-        headers: {
-            'Content-Type': 'application/json',
-            ...options.headers
-        }
-    });
-};
-
-/**
- * User login
- * Logs in a user and returns an access token
- */
-export const loginUser = <ThrowOnError extends boolean = false>(options: Options<LoginUserData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<LoginUserResponses, LoginUserErrors, ThrowOnError>({
-        url: '/api/auth/login',
-        ...options,
-        headers: {
-            'Content-Type': 'application/json',
-            ...options.headers
-        }
-    });
-};
-
-/**
- * Me request
- * Returns me data
- */
-export const getMe = <ThrowOnError extends boolean = false>(options?: Options<GetMeData, ThrowOnError>) => {
-    return (options?.client ?? _heyApiClient).get<GetMeResponses, GetMeErrors, ThrowOnError>({
-        url: '/api/auth/me/',
-        ...options
-    });
-};
-
-/**
- * Log out the authenticated user
- * Invalidates the user's token and logs them out
- */
-export const logoutUser = <ThrowOnError extends boolean = false>(options?: Options<LogoutUserData, ThrowOnError>) => {
-    return (options?.client ?? _heyApiClient).post<LogoutUserResponses, LogoutUserErrors, ThrowOnError>({
-        url: '/api/auth/logout',
-        ...options
-    });
-};
-
-/**
- * Refresh JWT token
- * Refreshes the current JWT token and returns a new one
- */
-export const refreshToken = <ThrowOnError extends boolean = false>(options?: Options<RefreshTokenData, ThrowOnError>) => {
-    return (options?.client ?? _heyApiClient).post<RefreshTokenResponses, RefreshTokenErrors, ThrowOnError>({
-        url: '/api/auth/refresh',
-        ...options
-    });
-};

package/src/types.gen.ts

@@ -1,150 +0,0 @@
-// This file is auto-generated by @hey-api/openapi-ts
-
-export type RegisterUserData = {
-    body: {
-        name: string;
-        email: string;
-        password: string;
-    };
-    path?: never;
-    query?: never;
-    url: '/api/auth/register';
-};
-
-export type RegisterUserErrors = {
-    /**
-     * Validation error
-     */
-    422: unknown;
-};
-
-export type RegisterUserResponses = {
-    /**
-     * User successfully registered
-     */
-    201: {
-        message?: string;
-        user?: {
-            id?: number;
-            name?: string;
-            email?: string;
-        };
-    };
-};
-
-export type RegisterUserResponse = RegisterUserResponses[keyof RegisterUserResponses];
-
-export type LoginUserData = {
-    body: {
-        email: string;
-        password: string;
-    };
-    path?: never;
-    query?: never;
-    url: '/api/auth/login';
-};
-
-export type LoginUserErrors = {
-    /**
-     * Invalid credentials
-     */
-    401: unknown;
-    /**
-     * Validation error
-     */
-    422: unknown;
-};
-
-export type LoginUserResponses = {
-    /**
-     * Successful login
-     */
-    200: {
-        access_token?: string;
-        token_type?: string;
-        expires_in?: number;
-    };
-};
-
-export type LoginUserResponse = LoginUserResponses[keyof LoginUserResponses];
-
-export type GetMeData = {
-    body?: never;
-    path?: never;
-    query?: never;
-    url: '/api/auth/me/';
-};
-
-export type GetMeErrors = {
-    /**
-     * Bad request
-     */
-    400: unknown;
-    /**
-     * Resource Not Found
-     */
-    404: unknown;
-};
-
-export type GetMeResponses = {
-    /**
-     * successful operation
-     */
-    200: unknown;
-};
-
-export type LogoutUserData = {
-    body?: never;
-    path?: never;
-    query?: never;
-    url: '/api/auth/logout';
-};
-
-export type LogoutUserErrors = {
-    /**
-     * Unauthenticated
-     */
-    401: unknown;
-};
-
-export type LogoutUserResponses = {
-    /**
-     * Successfully logged out
-     */
-    200: {
-        message?: string;
-    };
-};
-
-export type LogoutUserResponse = LogoutUserResponses[keyof LogoutUserResponses];
-
-export type RefreshTokenData = {
-    body?: never;
-    path?: never;
-    query?: never;
-    url: '/api/auth/refresh';
-};
-
-export type RefreshTokenErrors = {
-    /**
-     * Unauthorized
-     */
-    401: unknown;
-};
-
-export type RefreshTokenResponses = {
-    /**
-     * Token refreshed successfully
-     */
-    200: {
-        access_token?: string;
-        token_type?: string;
-        expires_in?: number;
-    };
-};
-
-export type RefreshTokenResponse = RefreshTokenResponses[keyof RefreshTokenResponses];
-
-export type ClientOptions = {
-    baseUrl: 'https://stage-api.adspire.ai' | (string & {});
-};

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "commonjs",
-    "declaration": true,
-    "outDir": "./dist",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "types": ["node"]
-  },
-  "include": ["src", "scripts"],
-  "exclude": ["node_modules", "dist"]
-}