kodzero-front-sdk-alfa 0.0.2

package/jest.config.ts

@@ -0,0 +1,190 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type {Config} from 'jest';
+
+const config: Config = {
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "\\\\node_modules\\\\",
+  //   "\\.pnp\\.[^\\\\]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};
+
+export default config;

package/nodemon.json

@@ -0,0 +1,4 @@
+{   
+    "ignore": [""],
+    "delay": "1000"
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "kodzero-front-sdk-alfa",
+  "version": "0.0.2",
+  "main": "dist/index.js",
+  "scripts": {
+    "tsc": "tsc -b src/",
+    "tsc-watch": "tsc --b --watch src/",
+    "tscw": "tsc --b --watch src/",
+    "dev": "nodemon dist/index.js",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "prepare": "npm version patch && npm run tsc"
+  },
+  "type": "module",
+  "author": "lesha2r",
+  "license": "ISC",
+  "description": "",
+  "dependencies": {
+    "fluid-fetch": "^0.0.2",
+    "validno": "^0.3.5"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@types/express": "^5.0.1",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.14.0",
+    "eslint": "^9.24.0",
+    "jest": "^29.7.0"
+  }
+}

package/src/Kodzero.ts

@@ -0,0 +1,35 @@
+import FluidFetch from "fluid-fetch"
+import { KodzeroAuth } from "./auth/index.js"
+import createModel from "./model/createModel.js"
+import { ModelOptions } from "./model/BaseModel.js"
+import { TokensManagerClass } from "./auth/tokens.js"
+
+interface Options {
+    host: string
+}
+
+class Kodzero {
+    host: string
+    auth: KodzeroAuth
+    tokensManager: TokensManagerClass
+    api: typeof FluidFetch
+
+    constructor (options: Options) {
+        this.tokensManager = new TokensManagerClass('', '')
+        this.host = options.host
+        this.api = new FluidFetch()
+        this.auth = new KodzeroAuth({host: options.host}, this.api, this.tokensManager)
+
+        this.api.middlewares.request.use((req: any) => {
+            const accessToken = this.tokensManager.access
+            if (accessToken) req.headers['Authorization'] = accessToken
+            return req
+        })
+    }
+
+    createModel = <T extends { _id?: string }, M = {}>(options: Omit<ModelOptions, 'host'>) => {
+        return createModel<T, M>({...options, host: this.host}, this.api)
+    }
+}
+
+export default Kodzero

package/src/auth/base.ts

@@ -0,0 +1,37 @@
+import FluidFetch from "fluid-fetch";
+import { AuthOptions } from "./index.js";
+import { TokensManagerClass } from "./tokens.js";
+import BaseAuthSchema from "../schemas/baseAuth.js";
+import validateApiResponse from "../utils/validateApiResponse.js";
+
+export class KodzeroAuthBase {
+    host: string;
+    api: typeof FluidFetch
+    tokensManager: TokensManagerClass
+
+    constructor(options: AuthOptions, api: typeof FluidFetch, tokensManager: TokensManagerClass) {
+        BaseAuthSchema.validateOrThrow(options);
+        
+        this.host = options.host
+        this.api = api
+        this.tokensManager = tokensManager
+    }
+
+    /**
+     * Private.
+     * Links to API error handler
+     */
+    _handleApiError(response: Response) {
+        return validateApiResponse(response)
+    }
+
+    /** 
+     * Base auth methods.
+     * These will be overridden by specific strategies (e.g. email, social, etc.)
+     */
+    signin = (...args: any[]): Promise<any> | void => {}
+    signup = (...args: any[]): Promise<any> | void => {}
+    refresh = (...args: any[]): Promise<any> | void => {}
+    signout = (...args: any[]): Promise<any> | void => {}
+    verify = (...args: any[]): Promise<any> | void => {}
+}

package/src/auth/email.ts

@@ -0,0 +1,123 @@
+import FluidFetch from "fluid-fetch"
+import { AuthOptions } from "./index.js"
+import { KodzeroAuthBase } from "./base.js"
+import { TokensManagerClass } from "./tokens.js"
+import buildURL from "../utils/buildURL_rename.js"
+
+interface KodzeroAuthEmailSignin {
+    email: string
+    password: string
+}
+
+class KodzeroAuthEmail extends KodzeroAuthBase {
+    tokensManager: TokensManagerClass
+    collection: "auth/password"
+
+    constructor(options: AuthOptions, api: typeof FluidFetch, tokensManager: TokensManagerClass) {
+        super(options, api, tokensManager)
+
+        this.tokensManager = tokensManager
+        this.collection = "auth/password"
+    }
+
+    /**
+     * Private.
+     * Setter for tokens in TokensManager
+     */
+    _setTokens = (access: string, refresh?: string) => {
+        this.tokensManager.setAccess(access)
+        if (refresh) this.tokensManager.setRefresh(refresh)
+    }
+
+    /**
+     * Sign in with email and password. On success, sets tokens in TokensManager automatically
+     */
+    signin = async (input: KodzeroAuthEmailSignin): Promise<{access: string, refresh: string}> => {
+        const url = buildURL(this.host, this.collection + '/signin')
+       
+        const response = await this.api.post(url, input)
+            .headers({ 'Content-Type': 'application/json' });
+
+        await this._handleApiError(response);        
+        const json = await response.json();
+
+        if (json.ok && json.tokens && json.tokens.access && json.tokens.refresh) {        
+            this._setTokens(json.tokens.access, json.tokens.refresh);
+        }
+    
+        return json.tokens
+    }
+
+    /**
+     *  Sign up with email and password. On success, sets tokens in TokensManager automatically
+     */
+    signup = async (userData: Record<string, string>): Promise<Record<string, any>> => {
+        const url = buildURL(this.host, this.collection + '/signup')
+        const response = await this.api.post(url, userData)
+            .headers({ 'Content-Type': 'application/json' });
+            
+        await this._handleApiError(response);        
+        const json = await response.json();
+
+        if (json.ok && json.result && json.result.tokens.access && json.result.tokens.refresh) {
+            this._setTokens(json.result.tokens.access, json.result.tokens.refresh);
+        }
+
+        return json.result.user
+    }
+
+    /**
+     * Verify current access token
+     */
+    verify = async (): Promise<any> => {
+        try {
+            const url = buildURL(this.host, this.collection + '/verify')
+            const response = await this.api.get(url)
+            const json = await response.json();
+
+            return json.ok ? true : false
+        } catch (error) {
+            console.warn("Token verification error:", error);
+            return false
+        }
+    }
+
+    /**
+     * Refresh access token using refresh token
+     * If success, updates access token in TokensManager automatically
+     */
+    refresh = async (): Promise<any> => {
+        const url = buildURL(this.host, this.collection + '/refresh')
+        const response = await this.api.post(url, { refresh: this.tokensManager.refresh })
+            .headers({ 'Content-Type': 'application/json' });
+
+        await this._handleApiError(response);        
+        const json = await response.json(); 
+        
+        if (json.ok && json.tokens && json.tokens.access) {
+            this.tokensManager.setAccess(json.tokens.access)
+        }
+
+        return json.ok ? true : false
+    }
+
+    /**
+     * Sign out the user
+     * If success, clears tokens in TokensManager automatically
+     */
+    signout = async (): Promise<any> => {
+        const url = buildURL(this.host, this.collection + '/signout')
+        const response = await this.api.post(url, {})
+            .headers({ 'Content-Type': 'application/json' });
+
+        await this._handleApiError(response);        
+        const json = await response.json(); 
+
+        if (json.ok) this.tokensManager.clear()
+
+        return json.ok ? true : false
+    }
+
+}
+
+export default KodzeroAuthEmail

package/src/auth/index.ts

@@ -0,0 +1,43 @@
+import FluidFetch from "fluid-fetch";
+import { KodzeroAuthBase } from "./base.js";
+import KodzeroAuthEmail from "./email.js";
+import { TokensManagerClass } from "./tokens.js";
+
+export interface AuthOptions {
+    host: string
+}
+
+export class KodzeroAuth extends KodzeroAuthBase {
+    email: KodzeroAuthEmail
+    setTokens: (access: string, refresh?: string) => void
+    clearTokens: () => void;
+
+    constructor(options: AuthOptions, api: typeof FluidFetch, tokensManager: TokensManagerClass) {
+        super(options, api, tokensManager)
+
+        // Email Strategy
+        this.email = new KodzeroAuthEmail(options, api, tokensManager)
+        
+        // Default methods set to email strategy methods
+        this.signin = this.email.signin
+        this.signup = this.email.signup
+        this.signout = this.email.signout
+        this.verify = this.email.verify
+        this.refresh = this.email.refresh
+
+        /**
+         * Set tokens in TokensManager. Used for manual token setting on startup.
+         */
+        this.setTokens = (access: string, refresh?: string) => {
+            tokensManager.setAccess(access)
+            if (refresh) tokensManager.setRefresh(refresh)
+        }
+
+        /**
+         * Clear tokens in TokensManager. Used for manual token clearing on necessary.
+         */
+        this.clearTokens = () => {
+            tokensManager.clear()
+        }
+    }
+}

package/src/auth/tokens.ts

@@ -0,0 +1,49 @@
+/**
+ * TokensManagerClass is responsible for managing access and refresh tokens.
+ * It provides methods to set, get, check existence, and clear tokens.
+ */
+export class TokensManagerClass {
+    access: string
+    refresh: string
+
+    constructor(access: string = '', refresh: string = '') {
+        this.access = access
+        this.refresh = refresh
+    }
+
+    /**
+     * Checks if access token exists
+     */
+    hasAccess() {
+        return this.access && this.access !== ''
+    }
+
+    /**
+     * Checks if refresh token exists
+     */
+    hasRefresh() {
+        return this.refresh && this.refresh !== ''
+    }
+
+    /**
+     * Sets the access token
+     */
+    setAccess(token: string) {
+        this.access = token
+    }
+
+    /**
+     * Sets the refresh token
+     */
+    setRefresh(token: string) {
+        this.refresh = token
+    }
+
+    /**
+     * Clears both access and refresh tokens
+     */
+    clear() {
+        this.access = ''
+        this.refresh = ''
+    }
+}

package/src/errors/KodzeroApiError.ts

@@ -0,0 +1,17 @@
+class KodzeroApiError extends Error {
+    url: string;
+    statusCode: number;
+    details: string;
+
+    constructor(url: string, statusCode: number, message: string, details?: string) {
+        
+        super(message);
+
+        this.name = "KodzeroApiError";
+        this.url = url;
+        this.statusCode = statusCode;
+        this.details = details || '';
+    }
+}
+
+export default KodzeroApiError

package/src/errors/KodzeroValidationError.ts

@@ -0,0 +1,12 @@
+class KodzeroValidationError extends Error {
+    errors: string[]
+
+    constructor(message: string, errors: string[] = []) {
+        super(message);
+
+        this.name = "KodzeroValidationError";
+        this.errors = errors;
+    }
+}
+
+export default KodzeroValidationError