@salesforce/analytics 1.0.23 → 1.2.0

package/lib/lib/analytics/dataflow/dataflow.d.ts

@@ -4,18 +4,57 @@ export type DataflowHistoryType = {
     name?: string;
     label?: string;
 };
-export type DataflowType = {
+export type DataflowType = Record<string, unknown> & {
     id?: string;
     namespace?: string;
     name?: string;
     label?: string;
     type?: string;
+    createdBy?: Record<string, unknown> & {
+        id?: string;
+        name?: string;
+        profilePhotoUrl?: string;
+    };
+    createdDate?: string;
+    definition?: unknown;
+    emailNotificationLevel?: string;
+    historiesUrl?: string;
+    lastModifiedBy?: Record<string, unknown> & {
+        id?: string;
+        name?: string;
+        profilePhotoUrl?: string;
+    };
+    lastModifiedDate?: string;
+    url?: string;
+};
+export type DataflowJobType = Record<string, unknown> & {
+    duration?: number;
+    id?: string;
+    jobType?: string;
+    label?: string;
+    nodesUrl?: string;
+    progress?: number;
+    retryCount?: number;
+    createdDate?: string;
+    executedDate?: string;
+    startDate?: string;
+    status?: 'Failure' | 'Queued' | 'Live' | 'Running' | 'Success' | 'Warning' | string;
+    syncDataflows?: [];
+    type?: string;
+    url?: string;
+    waitTime?: number;
 };
 export default class Dataflow {
     private readonly connection;
     private readonly dataflowsUrl;
+    private readonly dataflowsJobsUrl;
     constructor(organization: Org);
     list(): Promise<DataflowType[]>;
     getHistories(dataflowId: string): Promise<DataflowHistoryType[]>;
     revertToHistory(dataflowId: string, historyId: string, historyLabel?: string): Promise<string | undefined>;
+    startDataflow(dataflowId: string): Promise<DataflowJobType>;
+    stopDataflowJob(dataflowJobId: string): Promise<DataflowJobType>;
+    updateDataflow(dataflowId: string, definition: unknown): Promise<DataflowType>;
+    getDataflowJob(dataflowJobId: string): Promise<DataflowJobType>;
+    getDataflowJobs(dataflowId: string): Promise<DataflowJobType[]>;
 }

package/lib/lib/analytics/dataflow/dataflow.js

@@ -6,6 +6,7 @@ class Dataflow {
     constructor(organization) {
         this.connection = organization.getConnection();
         this.dataflowsUrl = `${this.connection.baseUrl()}/wave/dataflows/`;
+        this.dataflowsJobsUrl = `${this.connection.baseUrl()}/wave/dataflowjobs/`;
     }
     list() {
         return (0, request_1.fetchAllPages)(this.connection, this.dataflowsUrl, 'dataflows');
@@ -33,6 +34,68 @@ class Dataflow {
             (0, utils_1.throwError)(response);
         }
     }
+    async startDataflow(dataflowId) {
+        const command = 'start';
+        const response = await (0, request_1.connectRequest)(this.connection, {
+            method: 'POST',
+            url: this.dataflowsJobsUrl,
+            body: JSON.stringify({
+                dataflowId,
+                command
+            })
+        });
+        if (response) {
+            return response;
+        }
+        else {
+            (0, utils_1.throwError)(response);
+        }
+    }
+    async stopDataflowJob(dataflowJobId) {
+        const command = 'stop';
+        const response = await (0, request_1.connectRequest)(this.connection, {
+            method: 'PATCH',
+            url: this.dataflowsJobsUrl + encodeURIComponent(dataflowJobId),
+            body: JSON.stringify({
+                command
+            })
+        });
+        if (response) {
+            return response;
+        }
+        else {
+            (0, utils_1.throwError)(response);
+        }
+    }
+    async updateDataflow(dataflowId, definition) {
+        const response = await (0, request_1.connectRequest)(this.connection, {
+            method: 'PATCH',
+            url: this.dataflowsUrl + encodeURIComponent(dataflowId),
+            body: JSON.stringify({ definition })
+        });
+        if (response) {
+            return response;
+        }
+        else {
+            (0, utils_1.throwError)(response);
+        }
+    }
+    async getDataflowJob(dataflowJobId) {
+        const response = await (0, request_1.connectRequest)(this.connection, {
+            method: 'GET',
+            url: this.dataflowsJobsUrl + encodeURIComponent(dataflowJobId)
+        });
+        if (response) {
+            return response;
+        }
+        else {
+            (0, utils_1.throwError)(response);
+        }
+    }
+    async getDataflowJobs(dataflowId) {
+        const wtUrl = this.dataflowsJobsUrl + '?dataflowId=' + dataflowId;
+        return (0, request_1.fetchAllPages)(this.connection, wtUrl, 'dataflowJobs');
+    }
 }
 exports.default = Dataflow;
 //# sourceMappingURL=dataflow.js.map

package/lib/lib/analytics/dataflow/dataflow.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataflow.js","sourceRoot":"","sources":["../../../../src/lib/analytics/dataflow/dataflow.ts"],"names":[],"mappings":";;AAOA,wCAA2D;AAC3D,oCAAsC;AAetC,MAAqB,QAAQ;IAI3B,YAAmB,YAAiB;QAClC,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,kBAAkB,CAAC;IACrE,CAAC;IAEM,IAAI;QACT,OAAO,IAAA,uBAAa,EAAe,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IACtF,CAAC;IAEM,YAAY,CAAC,UAAkB;QACpC,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,GAAG,kBAAkB,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;QACrF,6GAA6G;QAC7G,+GAA+G;QAC/G,OAAO,IAAA,uBAAa,EAAsB,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACtF,CAAC;IAEM,KAAK,CAAC,eAAe,CAC1B,UAAkB,EAClB,SAAiB,EACjB,YAAqB;QAErB,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC;QACjD,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAc,EAAe,IAAI,CAAC,UAAU,EAAE;YACnE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,SAAS;gBACT,YAAY;aACb,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC,EAAE,CAAC;SACpB;aAAM;YACL,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;CACF;AAzCD,2BAyCC"}
+{"version":3,"file":"dataflow.js","sourceRoot":"","sources":["../../../../src/lib/analytics/dataflow/dataflow.ts"],"names":[],"mappings":";;AAOA,wCAA2D;AAC3D,oCAAsC;AAkDtC,MAAqB,QAAQ;IAK3B,YAAmB,YAAiB;QAClC,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,kBAAkB,CAAC;QACnE,IAAI,CAAC,gBAAgB,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,qBAAqB,CAAC;IAC5E,CAAC;IAEM,IAAI;QACT,OAAO,IAAA,uBAAa,EAAe,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IACtF,CAAC;IAEM,YAAY,CAAC,UAAkB;QACpC,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,GAAG,kBAAkB,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;QACrF,6GAA6G;QAC7G,+GAA+G;QAC/G,OAAO,IAAA,uBAAa,EAAsB,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IACtF,CAAC;IAEM,KAAK,CAAC,eAAe,CAC1B,UAAkB,EAClB,SAAiB,EACjB,YAAqB;QAErB,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC;QACjD,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAc,EAAe,IAAI,CAAC,UAAU,EAAE;YACnE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,SAAS;gBACT,YAAY;aACb,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC,EAAE,CAAC;SACpB;aAAM;YACL,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,UAAkB;QAC3C,MAAM,OAAO,GAAG,OAAO,CAAC;QACxB,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAc,EAAkB,IAAI,CAAC,UAAU,EAAE;YACtE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,IAAI,CAAC,gBAAgB;YAC1B,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,UAAU;gBACV,OAAO;aACR,CAAC;SACH,CAAC,CAAC;QACH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC;SACjB;aAAM;YACL,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,aAAqB;QAChD,MAAM,OAAO,GAAG,MAAM,CAAC;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAc,EAAkB,IAAI,CAAC,UAAU,EAAE;YACtE,MAAM,EAAE,OAAO;YACf,GAAG,EAAE,IAAI,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,aAAa,CAAC;YAC9D,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,OAAO;aACR,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC;SACjB;aAAM;YACL,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,UAAkB,EAAE,UAAmB;QACjE,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAc,EAAe,IAAI,CAAC,UAAU,EAAE;YACnE,MAAM,EAAE,OAAO;YACf,GAAG,EAAE,IAAI,CAAC,YAAY,GAAG,kBAAkB,CAAC,UAAU,CAAC;YACvD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC;SACrC,CAAC,CAAC;QACH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC;SACjB;aAAM;YACL,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,aAAqB;QAC/C,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAc,EAAkB,IAAI,CAAC,UAAU,EAAE;YACtE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,IAAI,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,aAAa,CAAC;SAC/D,CAAC,CAAC;QACH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC;SACjB;aAAM;YACL,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,UAAkB;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,GAAG,cAAc,GAAG,UAAU,CAAC;QAClE,OAAO,IAAA,uBAAa,EAAkB,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IAChF,CAAC;CACF;AA3GD,2BA2GC"}

package/lib/lib/analytics/recipe/recipe.d.ts

@@ -1,14 +1,56 @@
 import { Org } from '@salesforce/core';
-export type RecipeType = {
+export type RecipeType = Record<string, unknown> & {
+    conversionDetails: [];
+    createdBy?: {
+        id?: string;
+        name?: string;
+        profilePhotoUrl?: string;
+    };
+    createdDate?: string;
+    dataflowLastUpdate?: string;
+    dataset?: {
+        id?: string;
+        name?: string;
+        url?: string;
+    };
+    fileUrl?: string;
+    format?: string;
+    historiesUrl?: string;
     id?: string;
-    name?: string;
-    namespace?: string;
     label?: string;
+    lastModifiedBy?: {
+        id?: string;
+        name?: string;
+        profilePhotoUrl?: string;
+    };
+    lastModifiedDate?: string;
+    licenseAttributes?: {
+        type?: string;
+    };
+    name?: string;
+    publishingTarget?: string;
+    recipeDefinition?: {
+        name?: string;
+        nodes?: Record<string, unknown>;
+        ui?: Record<string, unknown>;
+        version?: string;
+    };
+    scheduleAttributes?: {
+        assetId: string;
+        frequency: string;
+    };
+    sourceRecipe?: string;
     status?: string;
+    targetDataflowId?: string;
+    type?: string;
+    url?: string;
+    validationDetails: [];
 };
 export default class Recipe {
     private readonly connection;
     private readonly recipesUrl;
+    private readonly dataflowsJobsUrl;
     constructor(organization: Org);
     list(): Promise<RecipeType[]>;
+    startRecipe(recipeId: string): Promise<RecipeType | undefined>;
 }

package/lib/lib/analytics/recipe/recipe.js

@@ -7,14 +7,40 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../request");
+const utils_1 = require("../utils");
 class Recipe {
     constructor(organization) {
         this.connection = organization.getConnection();
         this.recipesUrl = `${this.connection.baseUrl()}/wave/recipes/`;
+        this.dataflowsJobsUrl = `${this.connection.baseUrl()}/wave/dataflowjobs/`;
     }
     list() {
         return (0, request_1.fetchAllPages)(this.connection, this.recipesUrl, 'recipes');
     }
+    async startRecipe(recipeId) {
+        const startRecipeUrl = this.dataflowsJobsUrl;
+        const targetDataflowIdUrl = this.recipesUrl + recipeId + '?format=R3';
+        const command = 'start';
+        const recipeDetails = await (0, request_1.connectRequest)(this.connection, {
+            method: 'GET',
+            url: targetDataflowIdUrl
+        });
+        const dataflowId = recipeDetails.targetDataflowId;
+        const response = await (0, request_1.connectRequest)(this.connection, {
+            method: 'POST',
+            url: startRecipeUrl,
+            body: JSON.stringify({
+                dataflowId,
+                command
+            })
+        });
+        if (response) {
+            return response;
+        }
+        else {
+            (0, utils_1.throwError)(response);
+        }
+    }
 }
 exports.default = Recipe;
 //# sourceMappingURL=recipe.js.map

package/lib/lib/analytics/recipe/recipe.js.map

@@ -1 +1 @@
-{"version":3,"file":"recipe.js","sourceRoot":"","sources":["../../../../src/lib/analytics/recipe/recipe.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAGH,wCAA2C;AAU3C,MAAqB,MAAM;IAIzB,YAAmB,YAAiB;QAClC,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,gBAAgB,CAAC;IACjE,CAAC;IAEM,IAAI;QACT,OAAO,IAAA,uBAAa,EAAa,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IAChF,CAAC;CACF;AAZD,yBAYC"}
+{"version":3,"file":"recipe.js","sourceRoot":"","sources":["../../../../src/lib/analytics/recipe/recipe.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAGH,wCAA2D;AAC3D,oCAAsC;AA4BtC,MAAqB,MAAM;IAKzB,YAAmB,YAAiB;QAClC,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,gBAAgB,CAAC;QAC/D,IAAI,CAAC,gBAAgB,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,qBAAqB,CAAC;IAC5E,CAAC;IAEM,IAAI;QACT,OAAO,IAAA,uBAAa,EAAa,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,QAAgB;QACvC,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAC7C,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,GAAG,QAAQ,GAAG,YAAY,CAAC;QACtE,MAAM,OAAO,GAAG,OAAO,CAAC;QAExB,MAAM,aAAa,GAAG,MAAM,IAAA,wBAAc,EAAa,IAAI,CAAC,UAAU,EAAE;YACtE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,mBAAmB;SACzB,CAAC,CAAC;QACH,MAAM,UAAU,GAAG,aAAa,CAAC,gBAAgB,CAAC;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAc,EAAa,IAAI,CAAC,UAAU,EAAE;YACjE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,cAAc;YACnB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,UAAU;gBACV,OAAO;aACR,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC;SACjB;aAAM;YACL,IAAA,kBAAU,EAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;CACF;AAxCD,yBAwCC"}

package/messages/app.json

@@ -21,6 +21,8 @@
   "templatenameFlagLongDescription": "The name of the Analytics template.",
   "appnameFlagDescription": "app name",
   "appnameFlagLongDescription": "The name of the created app.",
+  "appdescriptionFlagDescription": "app description",
+  "appdescriptionFlagLongDescription": "The description of the created app.",
   "applogFlagDescription": "specify to include app creation log details",
   "applogFlagLongDescription": "Specify to include app creation log details.",
   "appCreateAsyncDescription": "create app asynchronously",

package/messages/autoinstall.json

@@ -26,6 +26,10 @@
   "autoinstallidFlagLongDescription": "ID of the auto-install request.",
   "applogFlagDescription": "specify to include app creation log details",
   "applogFlagLongDescription": "Specify to include app creation log details.",
+  "appnameFlagDescription": "app name",
+  "appnameFlagLongDescription": "The name of the created app.",
+  "appdescriptionFlagDescription": "app description",
+  "appdescriptionFlagLongDescription": "The description of the created app.",
   "displayLogHeader": "App Log",
   "displayNoLogAvailable": "No app log available.",
   "displayDateFormat": "YYYY-MM-DD HH:mm:ss",

package/messages/dataflow.json

@@ -1,5 +1,30 @@
 {
+  "missingRequiredField": "Missing Required Field: dataflowfile or dataflowstr",
+
   "listCommandDescription": "list Analytics dataflows",
   "listCommandLongDescription": "Lists Analytics dataflows in the specified target org.",
-  "dataflowsFound": "Found [%s] Analytics dataflows."
+  "dataflowsFound": "Found [%s] Analytics dataflows.",
+  "startCommandDescription": "start Analytics dataflows",
+  "startCommandLongDescription": "Start Analytics dataflows in the specified target org.",
+  "stopCommandDescription": "stop Analytics dataflows",
+  "stopCommandLongDescription": "Stop Analytics dataflows in the specified target org.",
+  "updateCommandDescription": "update Analytics dataflow",
+  "updateCommandLongDescription": "Update Analytics dataflow in the specified target org.",
+  "displayCommandDescription": "display status of Analytics dataflow",
+  "displayCommandLongDescription": "Display status of Analytics dataflow in the specified target org.",
+  "listJobsCommandDescription": "list jobs of Analytics dataflow",
+  "listJobsCommandLongDescription": "List jobs of Analytics dataflow in the specified target org.",
+
+  "dataflowidFlagDescription": "dataflow ID",
+  "dataflowidFlagLongDescription": "The ID of the dataflow to update.",
+  "dataflowjobIdFlagDescription": "dataflow Job ID",
+  "dataflowjobIdFlagLongDescription": "The ID of the dataflow job to update.",
+  "dataflowFileFlagDescription": "dataflow JSON file",
+  "dataflowFileFlagLongDescription": "The JSON of the dataflow to update.",
+  "dataflowJsonFlagDescription": "dataflow JSON string",
+  "dataflowJsonFlagLongDescription": "The JSON string of the dataflow to update.",
+
+  "dataflowJobUpdate": "Updated dataflow job (%s) status to (%s).",
+  "displayDetailHeader": "Dataflow Details",
+  "updateDataflow": "Successfully updated %s (%s) "
 }

package/messages/recipe.json

@@ -1,5 +1,11 @@
 {
   "listCommandDescription": "list Analytics recipes",
   "listCommandLongDescription": "Lists Analytics recipes in the specified target org.",
-  "recipesFound": "Found [%s] Analytics recipes."
+  "startCommandDescription": "start Analytics recipes",
+  "startCommandLongDescription": "Start Analytics recipes in the specified target org.",
+  "recipeidFlagDescription": "recipe ID",
+  "recipeidFlagLongDescription": "The ID of the recipe to update.",
+
+  "recipesFound": "Found [%s] Analytics recipes.",
+  "recipeJobUpdate": "Updated recipe job (%s) status to (%s)."
 }