@contentstack/cli-auth 1.3.6 → 1.3.8

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-auth
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-auth/1.3.6 linux-x64 node-v16.20.0
+@contentstack/cli-auth/1.3.8 linux-x64 node-v16.20.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/commands/auth/login.d.ts

@@ -0,0 +1,11 @@
+import { Command } from '@contentstack/cli-command';
+import { FlagInput } from '@contentstack/cli-utilities';
+export default class LoginCommand extends Command {
+    static run: any;
+    static description: string;
+    static examples: string[];
+    static flags: FlagInput;
+    static aliases: string[];
+    run(): Promise<any>;
+    login(username: string, password: string): Promise<void>;
+}

package/lib/commands/auth/logout.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@contentstack/cli-command';
+import { FlagInput } from '@contentstack/cli-utilities';
+export default class LogoutCommand extends Command {
+    static run: any;
+    static description: string;
+    static examples: string[];
+    static flags: FlagInput;
+    static aliases: string[];
+    run(): Promise<any>;
+}

package/lib/commands/auth/tokens/add.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@contentstack/cli-command';
+import { FlagInput } from '@contentstack/cli-utilities';
+export default class TokensAddCommand extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: FlagInput;
+    static usage: string;
+    run(): Promise<any>;
+}

package/lib/commands/auth/tokens/index.d.ts

@@ -0,0 +1,8 @@
+import { Command } from '@contentstack/cli-command';
+export default class TokensListCommand extends Command {
+    static aliases: string[];
+    static examples: string[];
+    static description: string;
+    static flags: Record<string, any>;
+    run(): Promise<any>;
+}

package/lib/commands/auth/tokens/remove.d.ts

@@ -0,0 +1,8 @@
+import { Command } from '@contentstack/cli-command';
+import { FlagInput } from '@contentstack/cli-utilities';
+export default class TokensRemoveCommand extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: FlagInput;
+    run(): Promise<any>;
+}

package/lib/commands/auth/whoami.d.ts

@@ -0,0 +1,7 @@
+import { Command } from '@contentstack/cli-command';
+export default class WhoamiCommand extends Command {
+    static description: string;
+    static examples: string[];
+    static aliases: string[];
+    run(): Promise<any>;
+}

package/lib/interfaces/index.d.ts

@@ -0,0 +1,20 @@
+export interface AuthOptions {
+    contentstackClient: any;
+}
+export interface ContentStackManagementClient {
+    contentstackClient: object;
+}
+export interface PrintOptions {
+    color?: string;
+}
+export interface InquirePayload {
+    type: string;
+    name: string;
+    message: string;
+    choices?: Array<any>;
+    transformer?: Function;
+}
+export interface User {
+    email: string;
+    authtoken: string;
+}

package/lib/utils/auth-handler.d.ts

@@ -0,0 +1,35 @@
+import { User } from '../interfaces';
+/**
+ * @class
+ * Auth handler
+ */
+declare class AuthHandler {
+    private _client;
+    private _host;
+    set client(contentStackClient: any);
+    set host(contentStackHost: any);
+    /**
+     *
+     *
+     * Login into Contentstack
+     * @param {string} email Contentstack email address
+     * @param {string} password User's password for contentstack account
+     * @returns {Promise} Promise object returns authtoken on success
+     * TBD: take out the otp implementation from login and create a new method/function to handle otp
+     */
+    login(email: string, password: string, tfaToken?: string): Promise<User>;
+    /**
+     * Logout from Contentstack
+     * @param {string} authtoken authtoken that needs to invalidated when logging out
+     * @returns {Promise} Promise object returns response object from Contentstack
+     */
+    logout(authtoken: string): Promise<object>;
+    /**
+     * Validate token
+     * @param {string} authtoken
+     * @returns {Promise} Promise object returns response object from Contentstack
+     */
+    validateAuthtoken(authtoken: string): Promise<object>;
+}
+declare const _default: AuthHandler;
+export default _default;

package/lib/utils/index.d.ts

@@ -0,0 +1,3 @@
+export { default as authHandler } from './auth-handler';
+export * as interactive from './interactive';
+export * as tokenValidation from './tokens-validation';

package/lib/utils/interactive.d.ts

@@ -0,0 +1,5 @@
+export declare const askPassword: () => Promise<string>;
+export declare const askOTPChannel: () => Promise<string>;
+export declare const askOTP: () => Promise<string>;
+export declare const askUsername: () => Promise<string>;
+export declare const askTokenType: () => Promise<string>;

package/lib/utils/tokens-validation.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Validate delivery token
+ * @param contentStackClient
+ * @param apiKey
+ * @param deliveryToken
+ * @param environment
+ * @param region
+ * @returns
+ */
+export declare const validateDeliveryToken: (contentStackClient: any, apiKey: string, deliveryToken: string, environment: string, region: string, host: string) => Promise<any>;
+/**
+ * Validate environment
+ * @param contentStackClient
+ * @param apiKey
+ * @param environment
+ * @returns
+ */
+export declare const validateEnvironment: (contentStackClient: any, apiKey: string, environment: string) => Promise<any>;
+/**
+ * Validate management token
+ * @param contentStackClient
+ * @param apiKey
+ * @param managementToken
+ * @returns { valid: boolean; message: any }
+ * Note: Fetching one content type using the management token to check whether it is valid or not
+ */
+export declare const validateManagementToken: (contentStackClient: any, apiKey: string, managementToken: string) => Promise<any>;
+/**
+ * Validate API key
+ * @param contentStackClient
+ * @param apiKey
+ * @returns
+ */
+export declare const validateAPIKey: (contentStackClient: any, apiKey: string) => Promise<any>;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.6",
+  "version": "1.3.8",
   "commands": {
     "auth:login": {
       "id": "auth:login",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-auth",
   "description": "Contentstack CLI plugin for authentication activities",
-  "version": "1.3.6",
+  "version": "1.3.8",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "scripts": {
@@ -21,8 +21,8 @@
     "test:unit": "mocha --forbid-only \"test/unit/*.test.ts\""
   },
   "dependencies": {
-    "@contentstack/cli-command": "^1.2.6",
-    "@contentstack/cli-utilities": "^1.4.2",
+    "@contentstack/cli-command": "^1.2.8",
+    "@contentstack/cli-utilities": "^1.4.4",
     "chalk": "^4.0.0",
     "debug": "^4.1.1",
     "inquirer": "8.2.4",
@@ -85,4 +85,4 @@
     }
   },
   "repository": "contentstack/cli"
-}
+}