const shortcut = require("../../shortcut.app");
const get = require("lodash/get");
const validate = require("validate.js");
const utils = require("../../utils");
const constants = require("../../constants");
module.exports = {
key: "shortcut-create-story",
name: "Create Story",
description: "Creates a new story in your Shortcut account. See [Create Story](https://shortcut.com/api/rest/v3#Create-Story) in Shortcut Rest API, V3 reference for endpoint documentation.",
version: "0.0.1",
type: "action",
props: {
shortcut,
archived: {
type: "boolean",
label: "Archived",
description: "Controls the story's archived state.",
default: false,
},
comment: {
type: "object",
label: "Comment",
description:
"A comment object attached to the story must have the following structure: `author_id` which is the member ID of the Comment’s author (defaults to the user identified by the API token), `created_at` which defaults to the time/date the comment is created, but can be set to reflect another date, `external_id` field that can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here, `text` is the comment text, and `updated_at` which defaults to the time/date the comment is last updated in Shortcut but can be set to reflect another time/date. See [CreateStoryCommentParams](https://shortcut.com/api/rest/v3#CreateStoryCommentParams) for more info.",
optional: true,
},
completedAtOverride: {
type: "string",
label: "Completed at Override Date",
description:
"A manual override for the time/date the Story was completed.",
optional: true,
},
createdAt: {
type: "string",
label: "Created at Date",
description: "The time/date the Story was created.",
optional: true,
},
dueDate: {
type: "string",
label: "Due Date",
description: "The due date of the story.",
optional: true,
},
description: {
type: "string",
label: "Description",
description: "The description of the story.",
default: "",
optional: true,
},
epicId: {
type: "integer",
label: "Epic ID",
description: "The unique identifier of the epic the story belongs to.",
async options() {
let options = [];
const epics = await this.shortcut.callWithRetry("listEpics");
const isEpicDataAvailable = get(epics, [
"data",
"length",
]);
if (!isEpicDataAvailable) {
return options;
}
options = epics.data.map((epic) => ({
label: epic.name,
value: epic.id,
}));
return options;
},
optional: true,
},
estimate: {
type: "integer",
label: "Estimate",
description:
"The numeric point estimate of the story. Can also be null, which means unestimated.",
optional: true,
},
externalId: {
type: "string",
label: "External Id",
description:
"This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.",
optional: true,
},
externalLinks: {
type: "string[]",
label: "External Links",
description: "A string array of External Links associated with this story.",
optional: true,
},
fileIds: {
type: "integer[]",
label: "File Ids",
description: "An array of IDs of files attached to the story.",
async options() {
let options = [];
const files = await this.shortcut.callWithRetry("listFiles");
const isFileDataAvailable = get(files, [
"data",
"length",
]);
if (!isFileDataAvailable) {
return options;
}
options = files.data.map((file) => ({
label: file.name,
value: file.id,
}));
return options;
},
optional: true,
},
followerIds: {
type: "string[]",
label: "Follower Ids",
description: "A string array of UUIDs of the followers of this story.",
async options() {
return await this.shortcut.listMembersAsOptions();
},
optional: true,
},
iterationId: {
type: "integer",
label: "Iteration Id",
description: "The ID of the iteration the story belongs to.",
async options() {
let options = [];
const iterations = await this.shortcut.callWithRetry("listIterations");
const isIterationDataAvailable = get(iterations, [
"data",
"length",
]);
if (!isIterationDataAvailable) {
return options;
}
options = iterations.data.map((iteration) => ({
label: iteration.name,
value: iteration.id,
}));
return options;
},
optional: true,
},
label: {
type: "object",
label: "Label",
description:
"A label object attached to the story. Each label object must have the following structure: `color` which is an string with the hex color to be displayed with the Label i.e. \"#ff0000\", and a string `name` for the name of the Label. See [CreateLabelParams](https://shortcut.com/api/rest/v3#CreateLabelParams) for more info.",
optional: true,
},
linkedFileIds: {
type: "integer[]",
label: "Linked File Ids",
description:
"An array of IDs of linked files attached to the story.",
async options() {
let options = [];
const linkedFiles = await this.shortcut.callWithRetry("listLinkedFiles");
const isLinkedFilesDataAvailable = get(linkedFiles, [
"data",
"length",
]);
if (!isLinkedFilesDataAvailable) {
return options;
}
options = linkedFiles.data.map((linkedFile) => ({
label: linkedFile.name,
value: linkedFile.id,
}));
return options;
},
optional: true,
},
name: {
type: "string",
label: "Name",
description: "The name of the story.",
},
ownerIds: {
type: "string[]",
label: "Owner Ids",
description: "A string array of UUIDs of the owners of this story.",
async options() {
return await this.shortcut.listMembersAsOptions();
},
optional: true,
},
projectId: {
type: "integer",
label: "Project Id",
description: "The ID of the project the story belongs to.",
async options() {
let options = [];
const projects = await this.shortcut.callWithRetry("listProjects");
const isProjectDataAvailable = get(projects, [
"data",
"length",
]);
if (!isProjectDataAvailable) {
return options;
}
options = projects.data.map((project) => ({
label: project.name,
value: project.id,
}));
return options;
},
},
requestedById: {
type: "string",
label: "Requested by ID",
description: "The ID of the member that requested the story.",
async options() {
return await this.shortcut.listMembersAsOptions();
},
optional: true,
},
startedAtOverride: {
type: "string",
label: "Started at Override Date",
description: "A manual override for the time/date the Story was started.",
optional: true,
},
storyLink: {
type: "object",
label: "Story Link",
description:
"An story link object attached to the story must have the following structure: `object_id` is the unique ID of the story defined as object, `subject_id` is the unique ID of the story defined as subject, and `verb` which indicates how the subject story acts on the object story, valid values are `blocks`, `duplicates`, or `relates to`. See [CreateStoryLinkParams](https://shortcut.com/api/rest/v3#CreateStoryLinkParams) for more info.",
optional: true,
},
storyType: {
type: "string",
label: "Story Type",
description: "The type of story (feature, bug, chore).",
options: constants.STORY_TYPES,
default: "feature",
optional: true,
},
task: {
type: "object",
label: "Task",
description:
"A task object attached to the story must have the following structure: `complete` which is a boolean, indicating whether the task is completed (defaults to `false`), `created_at` which defaults to the time/date the task is created but can be set to reflect another creation time/date, `description` as a description for the task, `external_id` a field can be set to another unique ID. In the case that the task has been imported from another tool, the ID in the other tool can be indicated here, `owner_ids` as an array of UUIDs for any members you want to add as owners on this new task, `updated_at` which defaults to the time/date the task was last updated in Shortcut but can be set to reflect another time/date. See [CreateTaskParams](https://shortcut.com/api/rest/v3#CreateTaskParams) for more info.",
optional: true,
},
updatedAt: {
type: "string",
label: "Updated at Date",
description: "The time/date the story was updated.",
optional: true,
},
workflowStateId: {
type: "integer",
label: "Workflow State Id",
description: "The ID of the workflow state the story will be in.",
async options() {
let options = [];
const workflows = await this.shortcut.callWithRetry("listWorkflows");
const isWorkflowDataAvailable = get(workflows, [
"data",
"length",
]);
if (!isWorkflowDataAvailable) {
return options;
}
return workflows.data.reduce(function (options, workflow) {
const hasState = get(workflow, [
"states",
"length",
]);
if (!hasState) {
return options;
}
const optionsToAdd = workflow.states.map((state) => ({
label: `${state.name} (${workflow.name})`,
value: `${state.id}`,
}));
return options.concat(optionsToAdd);
}, []);
},
optional: true,
},
},
async run() {
const constraints = {
name: {
length: {
maximum: 512,
},
},
description: {
length: {
maximum: 100000,
},
},
externalLinks: utils.validateArrayWhenPresent,
fileIds: utils.validateArrayWhenPresent,
followerIds: utils.validateArrayWhenPresent,
inkedFileIds: utils.validateArrayWhenPresent,
ownerIds: utils.validateArrayWhenPresent,
};
const validationResult = validate(
{
name: this.name,
description: this.description,
externalLinks: this.externalLinks,
fileIds: this.fileIds,
followerIds: this.followerIds,
linkedFileIds: this.linkedFileIds,
ownerIds: this.ownerIds,
},
constraints,
);
utils.checkValidationResults(validationResult);
const story = {
archived: this.archived,
completed_at_override: this.completedAtOverride,
created_at: this.createdAt,
deadline: this.dueDate,
description: this.description,
epic_id: this.epicId,
estimate: this.estimate,
external_id: this.externalId,
external_links: this.externalLinks,
file_ids: this.fileIds,
follower_ids: this.followerIds,
iteration_id: this.iterationId,
linked_file_ids: this.linkedFileIds,
name: this.name,
owner_ids: this.ownerIds,
project_id: this.projectId,
requested_by_id: this.requestedById,
started_at_override: this.startedAtOverride,
story_type: this.storyType,
updated_at: this.updatedAt,
workflow_state_id: this.workflowStateId,
};
const comment = utils.convertEmptyStringToUndefined(this.comment);
if (comment) {
story.comments = [
comment,
];
}
const label = utils.convertEmptyStringToUndefined(this.label);
if (label) {
story.labels = [
label,
];
}
const storyLink = utils.convertEmptyStringToUndefined(this.storyLink);
if (storyLink) {
story.story_links = [
storyLink,
];
}
const task = utils.convertEmptyStringToUndefined(this.task);
if (task) {
story.tasks = [
task,
];
}
const resp = await this.shortcut.callWithRetry("createStory", story);
return resp.data;
},
};
Chase Roberts@chsrbrts@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨@heyelliedayEvaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley@MBraedleyUpdate: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting@mrthomascuttingWant quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts@mattdotrobertsday 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭@auchenbergYahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑@raymondcamdenAwesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero@nachocaballeroI couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow@jyksnwDeveloped a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana@steven_terrana@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD@DotDotJamesWant to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin@AtinuxGitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul@raul_predescuIf you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc@bitfallsSo @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich@ZachLanichUm, wow 🤯 @pipedream
Steven Bell@bellontechI just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸@_jayhack_Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴♂️🌳@philsturgeonFor context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.