@crowdnode/sdk 1.0.0

package/Readme

@@ -0,0 +1,44 @@
+# Crowdnode SDK
+
+The **Crowdnode SDK** is the central "Contract" and communication layer between our **Backend** and our **Frontend**. 
+
+Instead of the Frontend and Backend "guessing" what the data looks like, this SDK acts as the single source of truth. It ensures security, privacy, and full type safety across the entire project.
+
+---
+
+## 1. The Three Pillars of Data
+We organize our data into three specific layers to ensure that sensitive database information never accidentally "leaks" to the user's phone.
+
+| Layer | Type Name | Where it lives | Purpose |
+| :--- | :--- | :--- | :--- |
+| **Storage** | `[Name]Storage` | Backend | The raw "ugly" data. Includes private IDs, internal flags, and sensitive dates. |
+| **Logic** | `[Name]Logic` | Backend/SDK | The "Brain." This version includes calculated fields (e.g., `isFundingActive`) and business rules used by the services. |
+| **UI** | `[Name]UI` | Frontend/SDK | The "Pretty" version. Sanitized and safe. This is the only version the Expo app is allowed to see. |
+| **Input** | `[Name]Input` | Shared | The "Form." Defines exactly what a user is allowed to send to the API when creating or updating something. |
+
+---
+
+## 2. How It Works (The Data Flow)
+
+The SDK facilitates a strict 3-step communication process:
+
+1.  **Definition:** We define the `Storage`, `Logic`, and `UI` types inside this SDK.
+2.  **Conversion (Backend):** The NestJS backend fetches a Storage object from the database. Before sending it back, it uses a *Converter* function to transform it into a UI object, stripping away any private data.
+3.  **Consumption (Frontend):** The frontend uses the `CrowdnodeClient` provided by this SDK. It automatically receives the UI type, providing full autocomplete and preventing crashes.
+
+
+
+---
+
+## 3. Repository Structure
+
+```text
+src/
+├── resources/
+│   ├── startups/           # Everything related to Startup data
+│   │   ├── startup.types.ts        # Storage, Logic, UI, and Input interfaces
+│   │   └── startup.client.ts       # The SDK functions for the Frontend
+│   └── campaigns/          # Everything related to Fundraising campaigns
+├── transport/
+│   └── http-client.ts             # Base configuration (Axios/Auth headers)
+└── index.ts                # Main entry point for the package

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { StartupClient } from './resources/startups/startup.client';
+export * from './resources/startups/startup.types';
+interface SDKConfig {
+    baseUrl: string;
+    getToken?: () => string | null;
+}
+export declare class CrowdnodeSDK {
+    startups: StartupClient;
+    private http;
+    constructor(config: SDKConfig);
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAGpE,cAAc,oCAAoC,CAAC;AAGnD,UAAU,SAAS;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,qBAAa,YAAY;IAChB,QAAQ,EAAE,aAAa,CAAC;IAC/B,OAAO,CAAC,IAAI,CAAa;gBAEb,MAAM,EAAE,SAAS;CAO9B"}

package/dist/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrowdnodeSDK = void 0;
+const http_client_1 = require("./transport/http-client");
+const startup_client_1 = require("./resources/startups/startup.client");
+// 1. Export all the types so the Frontend/Backend can use them
+__exportStar(require("./resources/startups/startup.types"), exports);
+class CrowdnodeSDK {
+    constructor(config) {
+        // Initialize the Engine
+        this.http = new http_client_1.HttpClient(config.baseUrl, config.getToken);
+        // Initialize the Resource Clients
+        this.startups = new startup_client_1.StartupClient(this.http);
+    }
+}
+exports.CrowdnodeSDK = CrowdnodeSDK;

package/dist/resources/startups/startup.client.d.ts

@@ -0,0 +1,9 @@
+import { HttpClient } from '../../transport/http-client';
+import { StartupUI, StartupInput } from './startup.types';
+export declare class StartupClient {
+    private api;
+    constructor(api: HttpClient);
+    getStartup(id: string): Promise<StartupUI>;
+    create(data: StartupInput): Promise<StartupUI>;
+}
+//# sourceMappingURL=startup.client.d.ts.map

package/dist/resources/startups/startup.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"startup.client.d.ts","sourceRoot":"","sources":["../../../src/resources/startups/startup.client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE1D,qBAAa,aAAa;IACZ,OAAO,CAAC,GAAG;gBAAH,GAAG,EAAE,UAAU;IAG7B,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAK1C,MAAM,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;CAIrD"}

package/dist/resources/startups/startup.client.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartupClient = void 0;
+class StartupClient {
+    constructor(api) {
+        this.api = api;
+    }
+    // The Promise returns the "UI" type, not the "Storage" type
+    async getStartup(id) {
+        const response = await this.api.get(`/startups/${id}`);
+        return response;
+    }
+    async create(data) {
+        const response = await this.api.post('/startups', data);
+        return response;
+    }
+}
+exports.StartupClient = StartupClient;

package/dist/resources/startups/startup.types.d.ts

@@ -0,0 +1,32 @@
+/**
+ */
+export interface StartupStorage {
+    id: number;
+    legal_name: string;
+    owner_id: string;
+    vault_address: string;
+    created_at: Date;
+}
+/**
+ */
+export interface StartupLogic {
+    id: string;
+    name: string;
+    ownerId: string;
+    blockchainReady: boolean;
+}
+/**
+ */
+export interface StartupUI {
+    id: string;
+    name: string;
+    isVerified: boolean;
+    avatarUrl: string;
+}
+/**
+ */
+export interface StartupInput {
+    name: string;
+    description: string;
+}
+//# sourceMappingURL=startup.types.d.ts.map

package/dist/resources/startups/startup.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"startup.types.d.ts","sourceRoot":"","sources":["../../../src/resources/startups/startup.types.ts"],"names":[],"mappings":"AAAA;GACG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,IAAI,CAAC;CAClB;AAED;GACG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;GACG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;GACG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB"}

package/dist/resources/startups/startup.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/transport/http-client.d.ts

@@ -0,0 +1,8 @@
+import { AxiosRequestConfig } from 'axios';
+export declare class HttpClient {
+    private instance;
+    constructor(baseUrl: string, getToken?: () => string | null);
+    get<T>(url: string, config?: AxiosRequestConfig): Promise<T>;
+    post<T>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+}
+//# sourceMappingURL=http-client.d.ts.map

package/dist/transport/http-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-client.d.ts","sourceRoot":"","sources":["../../src/transport/http-client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAiB,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAEjE,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAgB;gBAEpB,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI;IAmBrD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;IAK5D,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC;CAIhF"}

package/dist/transport/http-client.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+class HttpClient {
+    constructor(baseUrl, getToken) {
+        this.instance = axios_1.default.create({
+            baseURL: baseUrl,
+            headers: { 'Content-Type': 'application/json' },
+        });
+        // Automatically attach Auth Token if available (for Expo/Mobile)
+        if (getToken) {
+            this.instance.interceptors.request.use((config) => {
+                const token = getToken();
+                if (token) {
+                    config.headers.Authorization = `Bearer ${token}`;
+                }
+                return config;
+            });
+        }
+    }
+    // Generic methods that the Resource Clients will use
+    async get(url, config) {
+        const response = await this.instance.get(url, config);
+        return response.data;
+    }
+    async post(url, data, config) {
+        const response = await this.instance.post(url, data, config);
+        return response.data;
+    }
+}
+exports.HttpClient = HttpClient;

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@crowdnode/sdk",
+  "version": "1.0.0",
+  "description": "The **Crowdnode SDK** is the central \"Contract\" and communication layer between our **Backend** and our **Frontend**.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/crowdnode-it/crowdnode-sdk.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/crowdnode-it/crowdnode-sdk/issues"
+  },
+  "homepage": "https://github.com/crowdnode-it/crowdnode-sdk#readme",
+  "dependencies": {
+    "axios": "^1.16.0"
+  }
+}