@boxyhq/saml-jackson 0.2.3-beta.207 → 0.2.3-beta.219

package/src/typings.ts

@@ -0,0 +1,167 @@
+declare module 'saml-jackson' {
+  export type IdPConfig = {
+    defaultRedirectUrl: string;
+    redirectUrl: string;
+    tenant: string;
+    product: string;
+    rawMetadata: string;
+  };
+
+  export interface OAuth {
+    client_id: string;
+    client_secret: string;
+    provider: string;
+  }
+
+  export interface ISAMLConfig {
+    // Ensure backward compatibility
+    config(body: IdPConfig): Promise<OAuth>;
+
+    getConfig(body: {
+      clientID: string;
+      tenant: string;
+      product: string;
+    }): Promise<Partial<OAuth>>;
+
+    deleteConfig(body: {
+      clientID: string;
+      clientSecret: string;
+      tenant: string;
+      product: string;
+    }): Promise<void>;
+
+    // New methods
+    create(body: IdPConfig): Promise<OAuth>;
+
+    get(body: {
+      clientID: string;
+      tenant: string;
+      product: string;
+    }): Promise<Partial<OAuth>>;
+
+    delete(body: {
+      clientID: string;
+      clientSecret: string;
+      tenant: string;
+      product: string;
+    }): Promise<void>;
+  }
+
+  export interface IOAuthController {
+    authorize(body: OAuthReqBody): Promise<{ redirect_url: string }>;
+    samlResponse(body: SAMLResponsePayload): Promise<{ redirect_url: string }>;
+    token(body: OAuthTokenReq): Promise<OAuthTokenRes>;
+    userInfo(body: string): Promise<Profile>;
+  }
+
+  export interface OAuthReqBody {
+    response_type: 'code';
+    client_id: string;
+    redirect_uri: string;
+    state: string;
+    tenant: string;
+    product: string;
+    code_challenge: string;
+    code_challenge_method: 'plain' | 'S256' | '';
+    provider: 'saml';
+  }
+
+  export interface SAMLResponsePayload {
+    SAMLResponse: string;
+    RelayState: string;
+  }
+
+  export interface OAuthTokenReq {
+    client_id: string;
+    client_secret: string;
+    code_verifier: string;
+    code: string;
+    grant_type: 'authorization_code';
+  }
+
+  export interface OAuthTokenRes {
+    access_token: string;
+    token_type: 'bearer';
+    expires_in: number;
+  }
+
+  export interface Profile {
+    id: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+  }
+
+  export interface Index {
+    name: string;
+    value: string;
+  }
+
+  export interface DatabaseDriver {
+    get(namespace: string, key: string): Promise<any>;
+    put(
+      namespace: string,
+      key: string,
+      val: any,
+      ttl: number,
+      indexes: Index[]
+    ): Promise<any>;
+    delete(namespace: string, key: string): Promise<any>;
+    getByIndex(namespace: string, idx: Index): Promise<any>;
+  }
+
+  export interface Storable {
+    get(key: string): Promise<any>;
+    put(key: string, val: any, ...indexes: Index[]): Promise<any>;
+    delete(key: string): Promise<any>;
+    getByIndex(idx: Index): Promise<any>;
+  }
+
+  export interface Encrypted {
+    iv: string;
+    tag: string;
+    value: string;
+  }
+
+  export type EncryptionKey = any;
+
+  export type DatabaseEngine = 'redis' | 'sql' | 'mongo' | 'mem';
+
+  export type DatabaseType = 'postgres' | 'cockroachdb' | 'mysql' | 'mariadb';
+
+  export interface DatabaseOption {
+    engine: DatabaseEngine;
+    url: string;
+    type: DatabaseType;
+    ttl: number;
+    cleanupLimit: number;
+    encryptionKey: string;
+  }
+
+  export interface SAMLReq {
+    ssoUrl?: string;
+    entityID: string;
+    callbackUrl: string;
+    isPassive?: boolean;
+    forceAuthn?: boolean;
+    identifierFormat?: 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress';
+    providerName?: 'BoxyHQ';
+    signingKey: string;
+  }
+
+  export interface SAMLProfile {
+    audience: string;
+    claims: Record<string, any>;
+    issuer: string;
+    sessionIndex: string;
+  }
+
+  export interface JacksonOption {
+    externalUrl: string;
+    samlPath: string;
+    samlAudience?: string;
+    preLoadedConfig?: string;
+    idpEnabled?: boolean;
+    db: DatabaseOption;
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,6 @@
+
+  {
+    "extends": "./tsconfig.json",
+    "exclude": ["node_modules", "**/test/*"],
+  }
+

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist",
+    "allowJs": true,
+    "module": "CommonJS",
+    "target": "es6", //same as es2015
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitAny": false,
+    "strict": true,
+    "noImplicitThis": false,
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "declaration": true,
+    "noEmitOnError": false,
+    "noUnusedParameters": true,
+    "removeComments": false,
+    "strictNullChecks": true,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true
+  },
+  "include": ["./src/**/*"],
+  "exclude": ["node_modules"],
+  "ts-node": {
+    "files": true
+  }
+}

package/.nyc_output/522d751d-0cf8-42cc-9e6b-7c4f2c2ab0d4.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/93c45454-d3b6-48a7-9885-209592dc290a.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/da9b997e-732d-4bf2-a4e8-4b0568635c06.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/processinfo/522d751d-0cf8-42cc-9e6b-7c4f2c2ab0d4.json

@@ -1 +0,0 @@
-{"parent":"93c45454-d3b6-48a7-9885-209592dc290a","pid":3596,"argv":["/opt/hostedtoolcache/node/16.13.1/x64/bin/node","/home/runner/work/jackson/jackson/src/test/api.test.ts"],"execArgv":["-r","/home/runner/work/jackson/jackson/node_modules/ts-node/register/index.js"],"cwd":"/home/runner/work/jackson/jackson","time":1640694328676,"ppid":3579,"coverageFilename":"/home/runner/work/jackson/jackson/.nyc_output/522d751d-0cf8-42cc-9e6b-7c4f2c2ab0d4.json","externalId":"src/test/api.test.ts","uuid":"522d751d-0cf8-42cc-9e6b-7c4f2c2ab0d4","files":[]}

package/.nyc_output/processinfo/93c45454-d3b6-48a7-9885-209592dc290a.json

@@ -1 +0,0 @@
-{"parent":null,"pid":3579,"argv":["/opt/hostedtoolcache/node/16.13.1/x64/bin/node","/home/runner/work/jackson/jackson/node_modules/.bin/tap","--ts","--timeout=100","src/test/api.test.ts","src/test/oauth.test.ts"],"execArgv":[],"cwd":"/home/runner/work/jackson/jackson","time":1640694328360,"ppid":3568,"coverageFilename":"/home/runner/work/jackson/jackson/.nyc_output/93c45454-d3b6-48a7-9885-209592dc290a.json","externalId":"","uuid":"93c45454-d3b6-48a7-9885-209592dc290a","files":[]}

package/.nyc_output/processinfo/da9b997e-732d-4bf2-a4e8-4b0568635c06.json

@@ -1 +0,0 @@
-{"parent":"93c45454-d3b6-48a7-9885-209592dc290a","pid":3590,"argv":["/opt/hostedtoolcache/node/16.13.1/x64/bin/node","/home/runner/work/jackson/jackson/src/test/oauth.test.ts"],"execArgv":["-r","/home/runner/work/jackson/jackson/node_modules/ts-node/register/index.js"],"cwd":"/home/runner/work/jackson/jackson","time":1640694328650,"ppid":3579,"coverageFilename":"/home/runner/work/jackson/jackson/.nyc_output/da9b997e-732d-4bf2-a4e8-4b0568635c06.json","externalId":"src/test/oauth.test.ts","uuid":"da9b997e-732d-4bf2-a4e8-4b0568635c06","files":[]}

package/.nyc_output/processinfo/index.json

@@ -1 +0,0 @@
-{"processes":{"522d751d-0cf8-42cc-9e6b-7c4f2c2ab0d4":{"parent":"93c45454-d3b6-48a7-9885-209592dc290a","externalId":"src/test/api.test.ts","children":[]},"93c45454-d3b6-48a7-9885-209592dc290a":{"parent":null,"children":["522d751d-0cf8-42cc-9e6b-7c4f2c2ab0d4","da9b997e-732d-4bf2-a4e8-4b0568635c06"]},"da9b997e-732d-4bf2-a4e8-4b0568635c06":{"parent":"93c45454-d3b6-48a7-9885-209592dc290a","externalId":"src/test/oauth.test.ts","children":[]}},"files":{},"externalIds":{"src/test/api.test.ts":{"root":"522d751d-0cf8-42cc-9e6b-7c4f2c2ab0d4","children":[]},"src/test/oauth.test.ts":{"root":"da9b997e-732d-4bf2-a4e8-4b0568635c06","children":[]}}}