@niledatabase/server 1.0.0-alpha.195

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 The Nile Platform
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# @niledatabase/server
+
+Consolidates the API and DB for working with Nile.
+
+### Adding an endpoint:
+
+#### Add the openapi spec
+
+1. Find or add to `src` the name of the base property eg `src/tenants`
+1. Add a new folder with new method eg `src/tenants/createTenantUser`
+1. Add an `openapi/paths` folder under the method folder and insert a JSON openapi spec. [This helps with conversion](https://onlineyamltools.com/convert-yaml-to-json)
+1. If there are common schemas or responses, add them to `src/openapi` and reference them accordingly
+1. Update `/openapi/index.json` with any modifications, including the file you added/changed
+1. `yarn build` to be sure it works.
+
+#### Add new function to the sdk
+
+1. Add the method (using the method name) and a function for obtaining URL to the base index file with types eg`src/tenants/index` (this should be a lot of copy paste)
+1. Add a test under the method folder to be sure it goes to the correct url.

package/dist/Server.d.ts

@@ -0,0 +1,24 @@
+import { Knex } from 'knex';
+import { ServerConfig } from './types';
+import { Config } from './utils/Config';
+import Auth from './auth';
+import Users from './users';
+import Tenants from './tenants';
+declare type Api = {
+    auth: Auth;
+    users: Users;
+    tenants: Tenants;
+};
+declare class Server {
+    config: Config;
+    api: Api;
+    db: Knex;
+    constructor(config?: ServerConfig);
+    setConfig(cfg: Config): void;
+    get tenantId(): string | undefined | null;
+    set tenantId(tenantId: string | undefined | null);
+    get token(): string | undefined;
+    set token(token: string | undefined);
+}
+export default function Nile(config: ServerConfig): Server;
+export {};

package/dist/auth/index.d.ts

@@ -0,0 +1,20 @@
+import { RestModels } from '@niledatabase/js';
+import { Config } from '../utils/Config';
+import { NileRequest, NileResponse } from '../utils/Requester';
+export default class Auth extends Config {
+    constructor(config: Config);
+    get loginUrl(): string;
+    login: (req: NileRequest<RestModels.CreateBasicUserRequest>, init?: RequestInit | undefined) => NileResponse<RestModels.LoginUserResponse>;
+    loginSSO: (redirectUrl: string) => (req: NileRequest<unknown>) => NileResponse<RestModels.TenantSSORegistration[]>;
+    loginSSOUrl: (provider: string) => string;
+    get signUpUrl(): string;
+    signUp: (req: NileRequest<RestModels.CreateBasicUserRequest>, init?: RequestInit | undefined) => NileResponse<RestModels.LoginUserResponse>;
+    updateProviderUrl(providerName: string): string;
+    get listTenantProvidersUrl(): string;
+    listTenantProviders: (req: NileRequest<void | Headers>, init?: RequestInit | undefined) => NileResponse<RestModels.TenantSSORegistration[]>;
+    createProvider: (req: NileRequest<RestModels.RegisterTenantSSORequest>, init?: RequestInit | undefined) => NileResponse<RestModels.TenantSSORegistration>;
+    updateProvider: (req: NileRequest<RestModels.RegisterTenantSSORequest>, init?: RequestInit | undefined) => NileResponse<RestModels.TenantSSORegistration>;
+    providerUrl(email?: undefined | string): string;
+    listProviders: (req: NileRequest<void | RestModels.CreateBasicUserRequest>, init?: RequestInit | undefined) => NileResponse<RestModels.TenantSSORegistration[]>;
+    getSSOCallbackUrl: (param: Headers | string) => string;
+}

package/dist/db/index.d.ts

@@ -0,0 +1,9 @@
+import knex, { Knex } from 'knex';
+declare type IdParam = null | void | string | {
+    [key: string]: any;
+    id: string;
+};
+export declare function handleWithTenant(context: Knex.QueryBuilder, tenantId: IdParam): Promise<Knex.QueryBuilder>;
+export declare function handleWithUser(context: Knex.QueryBuilder, userId: IdParam): Promise<Knex.QueryBuilder>;
+export declare function extendKnex(): void;
+export default knex;

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { default as Server } from './Server';
+export default Server;

package/dist/index.js

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./server.cjs.production.min.js')
+} else {
+  module.exports = require('./server.cjs.development.js')
+}