v1.0.0 (#127)

.eslintrc

@@ -39,6 +39,7 @@
       "error",
       "never"
     ],
+    "brace-style": ["error", "stroustrup"],
     "perfectionist/sort-imports": "off",
     "perfectionist/sort-union-types": "off",
     "perfectionist/sort-classes": "off",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "shortcut-api",
-  "version": "1.0.0-beta.19",
+  "version": "1.0.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [

src/base-interface.ts

@@ -4,5 +4,5 @@ import UUID from '@sx/utils/uuid'
  * Base interface for Shortcut resources, representing the data returned from the API following JavaScript naming conventions.
  */
 export default interface BaseInterface {
-    id: UUID | number
+    id: UUID | number | null
 }

src/client.ts

@@ -1,4 +1,3 @@
-import UploadedFilesService from '@sx/uploaded-files/uploaded-files-service'
 import * as process from 'process'
 
 import CustomFieldsService from '@sx/custom-fields/custom-fields-service'
@@ -9,8 +8,10 @@ import LabelsService from '@sx/labels/labels-service'
 import LinkedFilesService from '@sx/linked-files/linked-files-service'
 import MembersService from '@sx/members/members-service'
 import ObjectivesService from '@sx/objectives/objectives-service'
+import RepositoriesService from '@sx/repositories/repositories-service'
 import StoriesService from '@sx/stories/stories-service'
 import TeamsService from '@sx/teams/teams-service'
+import UploadedFilesService from '@sx/uploaded-files/uploaded-files-service'
 import WorkflowService from '@sx/workflows/workflows-service'
 
 
@@ -46,6 +47,7 @@ export default class Client {
   public customFields: CustomFieldsService
   public linkedFiles: LinkedFilesService
   public uploadedFiles: UploadedFilesService
+  public repositories: RepositoriesService
 
   constructor(shortcutApiKey?: string) {
     if (shortcutApiKey) this.shortcutApiKey = shortcutApiKey
@@ -61,6 +63,7 @@ export default class Client {
     this.customFields = new CustomFieldsService({headers: this.headers})
     this.linkedFiles = new LinkedFilesService({headers: this.headers})
     this.uploadedFiles = new UploadedFilesService({headers: this.headers})
+    this.repositories = new RepositoriesService({headers: this.headers})
   }
 
 }

src/repositories/contracts/repository-api-data.ts

@@ -0,0 +1,23 @@
+import BaseData from '@sx/base-data'
+
+
+enum RepositoryType {
+  BITBUCKET = 'bitbucket',
+  GITHUB = 'github',
+  GITLAB = 'gitlab'
+}
+
+interface RepositoryApiData extends BaseData {
+  created_at: string | null
+  entity_type: string | null
+  external_id: string | null
+  full_name: string | null
+  id: number | null
+  name: string | null
+  type: RepositoryType | null
+  updated_at: string | null
+  url: string | null
+}
+
+export default RepositoryApiData
+export { RepositoryType }

src/repositories/contracts/repository.ts

@@ -0,0 +1,17 @@
+import BaseInterface from '@sx/base-interface'
+import {RepositoryType} from '@sx/repositories/contracts/repository-api-data'
+
+
+interface RepositoryInterface extends BaseInterface {
+  createdAt: Date | null
+  entityType: string | null
+  externalId: string | null
+  fullName: string | null
+  id: number | null
+  name: string | null
+  type: RepositoryType
+  updatedAt: Date | null
+  url: string | null
+}
+
+export default RepositoryInterface

src/repositories/repositories-service.ts

@@ -0,0 +1,12 @@
+import BaseService, {ServiceOperation} from '@sx/base-service'
+import RepositoryInterface from '@sx/repositories/contracts/repository'
+import Repository from '@sx/repositories/repository'
+
+
+class RepositoriesService extends BaseService<Repository, RepositoryInterface>{
+  public baseUrl = 'https://api.app.shortcut.com/api/v3/repositories'
+  protected factory = (data: RepositoryInterface) => new Repository(data)
+  public availableOperations: ServiceOperation[] = ['get', 'list']
+}
+
+export default RepositoriesService

src/repositories/repository.ts

@@ -0,0 +1,26 @@
+import ShortcutResource, {ResourceOperation} from '@sx/base-resource'
+import RepositoryInterface from '@sx/repositories/contracts/repository'
+import {RepositoryType} from '@sx/repositories/contracts/repository-api-data'
+
+
+class Repository extends ShortcutResource<RepositoryInterface> implements RepositoryInterface {
+  public availableOperations: ResourceOperation[] = []
+
+  createdAt: Date | null
+  entityType: string | null
+  externalId: string | null
+  fullName: string | null
+  id: number | null
+  name: string | null
+  type: RepositoryType
+  updatedAt: Date | null
+  url: string | null
+
+  constructor(init: RepositoryInterface) {
+    super()
+    Object.assign(this, init)
+    this.changedFields = []
+  }
+}
+
+export default Repository

src/stories/stories-service.ts

@@ -1,6 +1,10 @@
+import axios from 'axios'
+
 import {BaseSearchableService, ServiceOperation} from '@sx/base-service'
+import {StoryApiData} from '@sx/stories/contracts/story-api-data'
 import StoryInterface from '@sx/stories/contracts/story-interface'
 import Story from '@sx/stories/story'
+import {convertApiFields} from '@sx/utils/convert-fields'
 
 
 /**
@@ -14,4 +18,16 @@ export default class StoriesService extends BaseSearchableService<Story, StoryIn
   constructor(init: { headers: Record<string, string> }) {
     super(init)
   }
+
+  /**
+   * Fetches all stories that have an external link associated with them.
+   */
+  async getExternallyLinked(link: string): Promise<Story[]> {
+    const url = 'https://api.app.shortcut.com/api/v3/external-link/stories'
+    const response = await axios.get(url, { headers: this.headers, params: { external_link: link } })
+    return response.data.map((data: StoryApiData) => {
+      const interfaceData = convertApiFields(data)
+      return this.factory(interfaceData)
+    })
+  }
 }

src/stories/story.ts

@@ -180,7 +180,9 @@ class Story extends ShortcutResource<StoryInterface> implements StoryInterface {
       throw new Error(`Error creating comment: ${error}`)
     })
     const data: StoryCommentApiData = response.data
-    return convertApiFields(data) as StoryComment
+    const interfaceData = convertApiFields(data)
+
+    return new StoryComment(interfaceData)
   }
 
   public async addFile(file: Buffer): Promise<UploadedFile> {
@@ -195,7 +197,8 @@ class Story extends ShortcutResource<StoryInterface> implements StoryInterface {
       throw new Error(`Error adding task: ${error}`)
     })
     const data: TaskApiData = response.data
-    const createdTask = convertApiFields(data) as Task
+    const interfaceData = convertApiFields(data)
+    const createdTask = new Task(interfaceData)
     this.tasks.push(createdTask)
   }
 
@@ -286,4 +289,4 @@ class Story extends ShortcutResource<StoryInterface> implements StoryInterface {
   pullRequests: PullRequestInterface[]
 }
 
-export default Story
+export default Story

src/utils/convert-fields.ts

@@ -1,40 +1,42 @@
 import BaseCreateInterface from '@sx/base-create-interface'
 import BaseData from '@sx/base-data'
 import BaseInterface from '@sx/base-interface'
-import ShortcutResource from '@sx/base-resource'
 import camelToSnake from '@sx/utils/camel-to-snake'
 import isValidDatetimeFormat from '@sx/utils/is-valid-datetime-format'
 import snakeToCamel from '@sx/utils/snake-to-camel'
 
 
 type AnyObject = Record<string, unknown>
 
-export function convertApiFields<Input extends BaseData, Resource extends ShortcutResource | BaseInterface>(object: Input): Resource {
+function convertApiFields<Input extends BaseData, Resource extends BaseInterface>(object: Input): Resource {
   const convertObject = (obj: BaseData | BaseData[]): AnyObject | Array<object> => {
     if (Array.isArray(obj)) {
       return obj.map(item => convertObject(item)) // Recursively process each item in the array
-    } else if (obj !== null && typeof obj === 'object') {
+    }
+    else if (obj !== null && typeof obj === 'object') {
       const newObj: AnyObject = {}
       Object.keys(obj).forEach(key => {
         const camelKey = snakeToCamel(key)
         const value = obj[key]
         if (isValidDatetimeFormat(value as string)) {
 
           newObj[camelKey] = new Date(value as string)
-        } else {
+        }
+        else {
           newObj[camelKey] = typeof obj[key] === 'object' ? convertObject(obj[key] as AnyObject) : obj[key]
         }
       })
       return newObj
-    } else {
+    }
+    else {
       return obj
     }
   }
 
   return convertObject(object) as Resource
 }
 
-export function convertToApiFields<Input extends BaseCreateInterface, U extends BaseData>(object: Input): U {
+function convertToApiFields<Input extends BaseCreateInterface, U extends BaseData>(object: Input): U {
   const convertObject = (obj: BaseCreateInterface | BaseCreateInterface[]): AnyObject | Array<object> => {
     if (Array.isArray(obj)) {
       return obj.map(item => convertObject(item)) // Recursively process each item in the array
@@ -60,3 +62,5 @@ export function convertToApiFields<Input extends BaseCreateInterface, U extends
 
   return convertObject(object) as U
 }
+
+export {convertApiFields, convertToApiFields}

tests/respositories/repositories-service.test.ts

@@ -0,0 +1,11 @@
+import RepositoriesService from '@sx/repositories/repositories-service'
+
+
+describe('RepositoriesService', () => {
+  it('should instantiate a new RepositoriesService', () => {
+    const repositoriesService = new RepositoriesService({headers: {}})
+    expect(repositoriesService).toBeInstanceOf(RepositoriesService)
+    expect(repositoriesService.baseUrl).toEqual('https://api.app.shortcut.com/api/v3/repositories')
+    expect(repositoriesService.availableOperations).toEqual(['get', 'list'])
+  })
+})

tests/respositories/repository.test.ts

@@ -0,0 +1,30 @@
+import RepositoryInterface from '@sx/repositories/contracts/repository'
+import Repository from '@sx/repositories/repository'
+
+
+describe('Repository', () => {
+  it('should instantiate a new Repository', () => {
+    const repositoryData = {
+      createdAt: new Date(),
+      entityType: 'entityType',
+      externalId: 'externalId',
+      fullName: 'fullName',
+      id: 1,
+      name: 'name',
+      type: 'type',
+      updatedAt: new Date(),
+      url: 'url'
+    } as object as RepositoryInterface
+    const repository = new Repository(repositoryData)
+    expect(repository).toBeInstanceOf(Repository)
+    expect(repository.createdAt).toEqual(repositoryData.createdAt)
+    expect(repository.entityType).toEqual(repositoryData.entityType)
+    expect(repository.externalId).toEqual(repositoryData.externalId)
+    expect(repository.fullName).toEqual(repositoryData.fullName)
+    expect(repository.id).toEqual(repositoryData.id)
+    expect(repository.name).toEqual(repositoryData.name)
+    expect(repository.type).toEqual(repositoryData.type)
+    expect(repository.updatedAt).toEqual(repositoryData.updatedAt)
+    expect(repository.url).toEqual(repositoryData.url)
+  })
+})