@codecks/fetch 1.0.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (120) hide show
  1. package/README.md +79 -32
  2. package/dist/_exploration/api-requester.d.ts +3 -4
  3. package/dist/_exploration/api-requester.js +2 -2
  4. package/dist/_exploration/create-hooks.d.ts +4313 -13097
  5. package/dist/_exploration/create-hooks.js +1 -1
  6. package/dist/_exploration/loader.d.ts +2 -2
  7. package/dist/_exploration/loader.js +1 -1
  8. package/dist/_exploration/store.d.ts +5 -4
  9. package/dist/_exploration/store.js +1 -1
  10. package/dist/{collection-utils-T3bx0BS1.js → collection-utils-Ia_ahcpI.js} +4 -2
  11. package/dist/index-g5c30upI.d.ts +39 -0
  12. package/dist/index.d.ts +4 -19
  13. package/dist/index.js +26 -15
  14. package/dist/{loader-types-fd5tV0FD.d.ts → loader-types-D2Pf8qzH.d.ts} +1 -1
  15. package/dist/loader-utils-BZWanWDZ.d.ts +2218 -0
  16. package/dist/query-helpers-DndWBcMF.js +1203 -0
  17. package/dist/{query-type-BqQ9oX_U.d.ts → query-type-DPNcQFpZ.d.ts} +27 -13
  18. package/dist/store-ztk8y6Pm.d.ts +1203 -0
  19. package/package.json +2 -1
  20. package/schema/actions.md +789 -0
  21. package/schema/models/account.md +57 -90
  22. package/schema/models/attachment.md +15 -11
  23. package/schema/models/card.md +91 -65
  24. package/schema/models/cardHistory.md +15 -9
  25. package/schema/models/deck.md +41 -36
  26. package/schema/models/file.md +13 -15
  27. package/schema/models/handCard.md +8 -5
  28. package/schema/models/milestone.md +27 -22
  29. package/schema/models/milestoneProgress.md +9 -3
  30. package/schema/models/milestoneProject.md +6 -4
  31. package/schema/models/project.md +15 -39
  32. package/schema/models/projectTag.md +12 -7
  33. package/schema/models/queueEntry.md +12 -8
  34. package/schema/models/release.md +8 -6
  35. package/schema/models/resolvable.md +19 -15
  36. package/schema/models/resolvableEntry.md +16 -13
  37. package/schema/models/resolvableEntryReaction.md +16 -12
  38. package/schema/models/sprint.md +35 -25
  39. package/schema/models/sprintConfig.md +24 -20
  40. package/schema/models/sprintConfigProgress.md +9 -3
  41. package/schema/models/sprintProgress.md +9 -3
  42. package/schema/models/sprintProject.md +7 -5
  43. package/schema/models/user.md +15 -56
  44. package/schema/models/workflowItem.md +47 -31
  45. package/schema/overview.md +40 -93
  46. package/schema/query-syntax.md +1 -1
  47. package/schema/types.md +103 -0
  48. package/dist/_root-BW9uzB79.d.ts +0 -34
  49. package/dist/index-k-KPWV9R.d.ts +0 -2680
  50. package/dist/loader-utils-hvdC-xsQ.d.ts +0 -42
  51. package/dist/query-helpers-iX1fiqLv.js +0 -3062
  52. package/dist/store-BvEJzUVp.d.ts +0 -2667
  53. package/schema/models/accountOnboarding.md +0 -15
  54. package/schema/models/accountOnboardingStep.md +0 -14
  55. package/schema/models/accountRole.md +0 -19
  56. package/schema/models/accountUserAchievement.md +0 -17
  57. package/schema/models/accountUserSetting.md +0 -20
  58. package/schema/models/activeTimeTracker.md +0 -19
  59. package/schema/models/activity.md +0 -30
  60. package/schema/models/affiliateCode.md +0 -30
  61. package/schema/models/affiliateCodeStat.md +0 -19
  62. package/schema/models/app.md +0 -10
  63. package/schema/models/appInstallation.md +0 -19
  64. package/schema/models/assigneeAssignment.md +0 -18
  65. package/schema/models/assigneeDeckAssignment.md +0 -20
  66. package/schema/models/autoFinishedTimeTrackingSegment.md +0 -20
  67. package/schema/models/cardDiffNotification.md +0 -22
  68. package/schema/models/cardOrder.md +0 -17
  69. package/schema/models/cardOrderInDeck.md +0 -18
  70. package/schema/models/cardPreset.md +0 -19
  71. package/schema/models/cardSubscription.md +0 -19
  72. package/schema/models/cardUpvote.md +0 -21
  73. package/schema/models/cardsEffortHistory.md +0 -9
  74. package/schema/models/cardsFinishedHistory.md +0 -16
  75. package/schema/models/cardsStatusHistory.md +0 -9
  76. package/schema/models/cardsTimeToFinished.md +0 -18
  77. package/schema/models/dailyDiscordGuildVoteMembership.md +0 -15
  78. package/schema/models/dailyPublicProjectMembership.md +0 -15
  79. package/schema/models/deckAssignment.md +0 -18
  80. package/schema/models/deckGuardian.md +0 -17
  81. package/schema/models/deckSubscription.md +0 -18
  82. package/schema/models/discordGuild.md +0 -30
  83. package/schema/models/discordMember.md +0 -21
  84. package/schema/models/discordProjectNotification.md +0 -19
  85. package/schema/models/discordSlashCommand.md +0 -28
  86. package/schema/models/dueCard.md +0 -18
  87. package/schema/models/integration.md +0 -23
  88. package/schema/models/invoice.md +0 -21
  89. package/schema/models/lastSeenCardUpvote.md +0 -17
  90. package/schema/models/pinnedMilestone.md +0 -22
  91. package/schema/models/projectOrder.md +0 -18
  92. package/schema/models/projectSelection.md +0 -18
  93. package/schema/models/projectUser.md +0 -18
  94. package/schema/models/projectUserSetting.md +0 -15
  95. package/schema/models/publicProjectInfo.md +0 -20
  96. package/schema/models/publicProjectMembership.md +0 -17
  97. package/schema/models/publicProjectVisit.md +0 -16
  98. package/schema/models/queueSelection.md +0 -19
  99. package/schema/models/resolvableEntryHistory.md +0 -20
  100. package/schema/models/resolvableNotification.md +0 -30
  101. package/schema/models/resolvableParticipant.md +0 -25
  102. package/schema/models/resolvableParticipantHistory.md +0 -23
  103. package/schema/models/savedSearch.md +0 -18
  104. package/schema/models/stripeAccountSync.md +0 -29
  105. package/schema/models/timeTrackingSegment.md +0 -24
  106. package/schema/models/timeTrackingSum.md +0 -18
  107. package/schema/models/userDismissedHint.md +0 -16
  108. package/schema/models/userEmail.md +0 -18
  109. package/schema/models/userInvitation.md +0 -20
  110. package/schema/models/userInviteCode.md +0 -23
  111. package/schema/models/userOnboarding.md +0 -14
  112. package/schema/models/userProjectAccess.md +0 -17
  113. package/schema/models/userReportEmail.md +0 -19
  114. package/schema/models/userReportSetting.md +0 -23
  115. package/schema/models/userReportToken.md +0 -18
  116. package/schema/models/userTag.md +0 -18
  117. package/schema/models/visionBoard.md +0 -21
  118. package/schema/models/visionBoardQuery.md +0 -22
  119. package/schema/models/wizard.md +0 -19
  120. package/schema/models/workflowItemHistory.md +0 -18
@@ -1,67 +1,26 @@
1
1
  # user
2
2
 
3
+ A person, or an integration or API token that acts in an organization. `kind` tells them apart.
4
+
3
5
  Key: `id`
4
6
 
5
7
  ## Fields
6
8
 
7
- - `id`: string
8
- - `name`: string
9
- - `fullName`: string, optional
10
- - `timezone`: string, optional
11
- - `createdAt`: Date (ISO string)
12
- - `hasPassword`: boolean
13
- - `showCardIdInTimer`: boolean
14
- - `disableMovingImages`: boolean
15
- - `autoMeFilterCardLimit`: number, optional
16
- - `isIntegration`: boolean
17
- - `statusColorPalette`: string
18
- - `wantsNewsletter`: boolean, optional
19
- - `wantsDailyDigestMail`: boolean, optional
20
- - `wantsConvoDigestMail`: boolean, optional
21
- - `disableAnimations`: boolean
22
- - `enableClickToEditCards`: boolean
23
- - `cdxRole`: string
24
- - `profileImageId`: string (foreign key ID) → file, optional
25
- - `lastSeenReleaseId`: string (foreign key ID) → release
9
+ - `fullName`: `string | null`
10
+ `null` unless the user entered one.
11
+ - `id`: `UserId`
12
+ - `isIntegration`: `boolean`
13
+ `true` for every `kind` other than `human`.
14
+ - `kind`: `"human" | "integration" | "api_token" | (string & {})`
15
+ `integration` is the user an integration like GitHub or Slack acts as, `api_token` the one an organization's API token acts as.
16
+ - `name`: `string`
17
+ The username. `""` when none is set. An API token's user carries the token's label.
18
+ - `profileImageId`: [`FileId`](file.md)` | null`, foreign key of `profileImage`
19
+ - `timezone`: `string | null` — **preview**
20
+ An IANA time zone like `Europe/Berlin`. Only readable on your own user: `null` on everyone else's.
26
21
 
27
22
  ## Relations
28
23
 
29
24
  ### belongsTo
30
25
 
31
- - `profileImage` → [file](file.md) (via `profileImageId`)
32
- - `lastSeenRelease` → [release](release.md) (via `lastSeenReleaseId`)
33
-
34
- ### hasOne
35
-
36
- - `primaryEmail` → [userEmail](userEmail.md)
37
- - `pinnedMilestoneNext` → [pinnedMilestone](pinnedMilestone.md)
38
- - `activeTimeTracker` → [activeTimeTracker](activeTimeTracker.md)
39
- - `userOnboarding` → [userOnboarding](userOnboarding.md)
40
-
41
- ### hasMany
42
-
43
- - `projectOrders` → [projectOrder](projectOrder.md)
44
- - `projectSelections` → [projectSelection](projectSelection.md)
45
- - `queueSelections` → [queueSelection](queueSelection.md)
46
- - `accountRoles` → [accountRole](accountRole.md)
47
- - `cardDiffNotifications` → [cardDiffNotification](cardDiffNotification.md)
48
- - `resolvableNotifications` → [resolvableNotification](resolvableNotification.md)
49
- - `publicProjectMembership` → [publicProjectMembership](publicProjectMembership.md)
50
- - `lastSeenCardUpvotes` → [lastSeenCardUpvote](lastSeenCardUpvote.md)
51
- - `dueCards` → [dueCard](dueCard.md)
52
- - `assigneeDeckAssignments` → [assigneeDeckAssignment](assigneeDeckAssignment.md)
53
- - `autoFinishedTimeTrackingSegments` → [autoFinishedTimeTrackingSegment](autoFinishedTimeTrackingSegment.md)
54
- - `savedSearches` → [savedSearch](savedSearch.md)
55
- - `activities` → [activity](activity.md)
56
- - `emails` → [userEmail](userEmail.md)
57
- - `tags` → [userTag](userTag.md)
58
- - `unverifiedEmails` → [userEmail](userEmail.md)
59
- - `projectAccess` → [projectUser](projectUser.md)
60
- - `explicitProjectAccess` → [projectUser](projectUser.md)
61
- - `withProjectAccess` → [userProjectAccess](userProjectAccess.md)
62
- - `projectSettings` → [projectUserSetting](projectUserSetting.md)
63
- - `accountSettings` → [accountUserSetting](accountUserSetting.md)
64
- - `dismissedHints` → [userDismissedHint](userDismissedHint.md)
65
- - `slackIntegrations` → [integration](integration.md)
66
- - `participations` → [resolvableParticipant](resolvableParticipant.md)
67
- - `upvotes` → [cardUpvote](cardUpvote.md)
26
+ - `profileImage` → [file](file.md) (via `profileImageId`), optional
@@ -1,45 +1,61 @@
1
1
  # workflowItem
2
2
 
3
+ A Journey Step: a template for a sub card. Starting a deck's journey on a card creates a sub card from each of its steps.
4
+
5
+ **preview**: this model may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/).
6
+
3
7
  Key: `itemId`
4
8
 
5
9
  ## Fields
6
10
 
7
- - `itemId`: string
8
- - `version`: string
9
- - `sortOrder`: string
10
- - `sortValue`: string
11
- - `priority`: string, optional
12
- - `content`: string
13
- - `createdAt`: Date (ISO string)
14
- - `lastUpdatedAt`: Date (ISO string)
15
- - `tags`: array
16
- - `masterTags`: array
17
- - `mentionedUsers`: array
18
- - `title`: string
19
- - `effort`: number, optional
20
- - `label`: string, optional
21
- - `checkboxStats`: object
22
- - `accountSeq`: number
23
- - `checkboxInfo`: array
24
- - `visibility`: string
25
- - `accountId`: string (foreign key ID) → account
26
- - `deckId`: string (foreign key ID) → deck
27
- - `targetDeckId`: string (foreign key ID) → deck, optional
28
- - `assigneeId`: string (foreign key ID) → user, optional
29
- - `creatorId`: string (foreign key ID) → user
11
+ - `accountId`: [`AccountId`](account.md), foreign key of `account` — **preview**
12
+ - `accountSeq`: `number` — **preview**
13
+ The step's number within the organization. It comes from the same counter as `card.accountSeq`.
14
+ - `assigneeId`: [`UserId`](user.md)` | null`, foreign key of `assignee` — **preview**
15
+ The owner of the created card.
16
+ - `checkboxInfo`: [`Checkbox`](../types.md#checkbox)`[]` — **preview**
17
+ - `checkboxStats`: [`CheckboxStats`](../types.md#checkboxstats) — **preview**
18
+ - `content`: `string` — **preview**
19
+ Markdown for the created card's `content`, see `card.content`. `%PARENT_TITLE%` is replaced by the title of the card the journey is started on.
20
+ - `createdAt`: `Date` (sent as an ISO timestamp) — **preview**
21
+ - `creatorId`: [`UserId`](user.md), foreign key of `creator` — **preview**
22
+ - `deckId`: [`DeckId`](deck.md), foreign key of `deck` — **preview**
23
+ The deck whose journey the step belongs to.
24
+ - `effort`: `number | null` — **preview**
25
+ - `itemId`: `WorkflowItemId`
26
+ - `label`: `string | null` — **preview**
27
+ The name of the group the step is in. `null` for the default group.
28
+ - `lastUpdatedAt`: `Date` (sent as an ISO timestamp) — **preview**
29
+ - `masterTags`: `string[]` — **preview**
30
+ - `mentionedUsers`: [`UserId`](user.md)`[]` — **preview**
31
+ - `priority`: [`Priority`](../types.md#priority)` | null` — **preview**
32
+ - `sortValue`: `string` — **preview**
33
+ Steps are ordered by ascending `sortValue`, compared as strings, within their `label` group.
34
+ - `tags`: `string[]` — **preview**
35
+ - `targetDeckId`: [`DeckId`](deck.md)` | null`, foreign key of `targetDeck` — **preview**
36
+ The deck the created card goes to. Without one, it goes to `deck`.
37
+ - `title`: `string` — **preview**
38
+ - `version`: `number` — **preview**
39
+ Goes up with every change to the step.
40
+ - `visibility`: [`CardVisibility`](../types.md#cardvisibility) — **preview**
41
+ Only `default` steps are used when a journey is started. Changing an archived or deleted step sets it back to `default`.
30
42
 
31
43
  ## Relations
32
44
 
33
45
  ### belongsTo
34
46
 
35
- - `account` → [account](account.md) (via `accountId`)
36
- - `deck` → [deck](deck.md) (via `deckId`)
37
- - `targetDeck` → [deck](deck.md) (via `targetDeckId`)
38
- - `assignee` → [user](user.md) (via `assigneeId`)
39
- - `creator` → [user](user.md) (via `creatorId`)
47
+ - `account` → [account](account.md) (via `accountId`) — **preview**
48
+ - `assignee` → [user](user.md) (via `assigneeId`), optional — **preview**
49
+ The owner of the created card.
50
+ - `creator` → [user](user.md) (via `creatorId`) — **preview**
51
+ - `deck` → [deck](deck.md) (via `deckId`) — **preview**
52
+ The deck whose journey the step belongs to.
53
+ - `targetDeck` → [deck](deck.md) (via `targetDeckId`), optional — **preview**
54
+ The deck the created card goes to. Without one, it goes to `deck`.
40
55
 
41
56
  ### hasMany
42
57
 
43
- - `diffs` → [workflowItemHistory](workflowItemHistory.md)
44
- - `inDeps` → [workflowItem](workflowItem.md) — `fkAsArray` (plain selection + `count`/`exists` only; no `filter`/`orderBy`/`limit`/`offset`/`first`)
45
- - `outDeps` → [workflowItem](workflowItem.md) — `fkAsArray` (plain selection + `count`/`exists` only; no `filter`/`orderBy`/`limit`/`offset`/`first`)
58
+ - `inDeps` → [workflowItem](workflowItem.md) — `fkAsArray` (plain selection + `count`/`exists` only; no `filter`/`orderBy`/`limit`/`offset`/`first`) — **preview**
59
+ Steps of the same journey that have to be done before this one. The created cards get the same dependencies.
60
+ - `outDeps` → [workflowItem](workflowItem.md) — `fkAsArray` (plain selection + `count`/`exists` only; no `filter`/`orderBy`/`limit`/`offset`/`first`) — **preview**
61
+ Steps of the same journey that are blocked by this one.
@@ -1,110 +1,57 @@
1
1
  # @codecks/fetch Schema Overview
2
2
 
3
+ ## Stability
4
+
5
+ These files list what the Codecks API documents. Anything else the API answers is internal and can change without notice.
6
+
7
+ - **stable** (unmarked): changes only after a deprecation and 6 months' notice, see [Stability](https://manual.codecks.io/api/#stability).
8
+ - **preview**: may change in any release. Each change is listed in the [API changelog](https://manual.codecks.io/api-changelog/). The TypeScript types mark these `@experimental`.
9
+ - **deprecated**: still answered until the date given, then removed. The TypeScript types mark these `@deprecated`.
10
+
3
11
  ## Root Entry Points
4
12
 
5
13
  These relations are available when using `fetchFromRoot`:
6
14
 
7
- - `releases` (hasMany) → [release](models/release.md)
8
- - `accountOnboardingSteps` (hasMany) → [accountOnboardingStep](models/accountOnboardingStep.md)
9
- - `apps` (hasMany) → [app](models/app.md)
10
15
  - `account` (hasOne) → [account](models/account.md)
16
+ The organization the request is for.
11
17
  - `loggedInUser` (hasOne) → [user](models/user.md)
12
- - `cardsStatusHistory` (hasMany) → [cardsStatusHistory](models/cardsStatusHistory.md)
13
- - `cardsEffortHistory` (hasMany) → [cardsEffortHistory](models/cardsEffortHistory.md)
14
- - `cardsFinishedHistory` (hasMany) → [cardsFinishedHistory](models/cardsFinishedHistory.md)
15
- - `cardsTimeToFinished` (hasMany) → [cardsTimeToFinished](models/cardsTimeToFinished.md)
18
+ The user the request acts as. For an organization's API token it's the token's own user. `null` when nobody is signed in.
19
+ - `releases` (hasMany) → [release](models/release.md)
20
+ The entries of the Codecks changelog.
21
+
22
+ ## Types
23
+
24
+ Model pages give each field's TypeScript type. Named types (enums, json shapes) are listed in [types.md](types.md) and exported from the package: [`CardVisibility`](types.md#cardvisibility), [`Checkbox`](types.md#checkbox), [`CheckboxStats`](types.md#checkboxstats), [`DefaultCard`](types.md#defaultcard), [`DerivedStatus`](types.md#derivedstatus), [`MilestoneColor`](types.md#milestonecolor), [`Priority`](types.md#priority), [`StartWeekday`](types.md#startweekday), [`TimeTrackingMode`](types.md#timetrackingmode), [`TimelineScaleType`](types.md#timelinescaletype), [`Workdays`](types.md#workdays), [`WorkflowMode`](types.md#workflowmode).
25
+
26
+ Enums are open unions like `"a" | "b" | (string & {})`: the API may add values, so handle unknown ones.
27
+
28
+ ## Actions
29
+
30
+ Changes go through `dispatch(name, params)`. [actions.md](actions.md) lists all 42, with their params and responses.
16
31
 
17
32
  ## All Models
18
33
 
19
- - [accountOnboardingStep](models/accountOnboardingStep.md) (key: key) — 8 fields, 0 relations
20
- - [accountOnboarding](models/accountOnboarding.md) (key: accountId) — 3 fields, 1 relations
21
- - [accountRole](models/accountRole.md) (key: accountId, userId) — 6 fields, 2 relations
22
- - [accountUserAchievement](models/accountUserAchievement.md) (key: accountId, userId, key) — 4 fields, 2 relations
23
- - [accountUserSetting](models/accountUserSetting.md) (key: accountId, userId) — 6 fields, 3 relations
24
- - [account](models/account.md) (key: id) — 45 fields, 42 relations
25
- - [activeTimeTracker](models/activeTimeTracker.md) (key: id) — 5 fields, 3 relations
26
- - [activity](models/activity.md) (key: id) — 13 fields, 6 relations
27
- - [affiliateCodeStat](models/affiliateCodeStat.md) (key: affiliateCodeId, month) — 7 fields, 1 relations
28
- - [affiliateCode](models/affiliateCode.md) (key: id) — 13 fields, 3 relations
29
- - [appInstallation](models/appInstallation.md) (key: id) — 5 fields, 3 relations
30
- - [app](models/app.md) (key: id) — 4 fields, 0 relations
31
- - [assigneeAssignment](models/assigneeAssignment.md) (key: assigneeId, assignedById) — 4 fields, 3 relations
32
- - [assigneeDeckAssignment](models/assigneeDeckAssignment.md) (key: assigneeId, assignedById, deckId) — 5 fields, 4 relations
34
+ - [account](models/account.md) (key: id) — 22 fields, 13 relations
33
35
  - [attachment](models/attachment.md) (key: id) — 8 fields, 4 relations
34
- - [autoFinishedTimeTrackingSegment](models/autoFinishedTimeTrackingSegment.md) (key: userId, accountId) — 5 fields, 4 relations
35
- - [cardDiffNotification](models/cardDiffNotification.md) (key: userId, cardId) — 8 fields, 3 relations
36
- - [cardHistory](models/cardHistory.md) (key: cardId, version) — 6 fields, 3 relations
37
- - [cardOrderInDeck](models/cardOrderInDeck.md) (key: cardId, deckId) — 4 fields, 3 relations
38
- - [cardOrder](models/cardOrder.md) (key: context, cardId) — 4 fields, 2 relations
39
- - [cardPreset](models/cardPreset.md) (key: id) — 6 fields, 2 relations
40
- - [cardSubscription](models/cardSubscription.md) (key: id) — 5 fields, 3 relations
41
- - [cardUpvote](models/cardUpvote.md) (key: id) — 7 fields, 3 relations
42
- - [card](models/card.md) (key: cardId) — 37 fields, 28 relations
43
- - [cardsEffortHistory](models/cardsEffortHistory.md) (key: date, effortSum, cardCount) — 3 fields, 0 relations
44
- - [cardsFinishedHistory](models/cardsFinishedHistory.md) (key: date, effortSum, cardCount, assigneeId) — 4 fields, 1 relations
45
- - [cardsStatusHistory](models/cardsStatusHistory.md) (key: date, status, count) — 3 fields, 0 relations
46
- - [cardsTimeToFinished](models/cardsTimeToFinished.md) (key: cardId, startedAt, doneAt, effort, assigneeId) — 5 fields, 2 relations
47
- - [dailyDiscordGuildVoteMembership](models/dailyDiscordGuildVoteMembership.md) (key: t, guildId) — 3 fields, 1 relations
48
- - [dailyPublicProjectMembership](models/dailyPublicProjectMembership.md) (key: t, projectId) — 3 fields, 1 relations
49
- - [publicProjectVisit](models/publicProjectVisit.md) (key: t, projectId) — 4 fields, 1 relations
50
- - [deckAssignment](models/deckAssignment.md) (key: userId, deckId) — 4 fields, 3 relations
51
- - [deckGuardian](models/deckGuardian.md) (key: deckId, userId) — 3 fields, 3 relations
52
- - [deckSubscription](models/deckSubscription.md) (key: id) — 4 fields, 3 relations
53
- - [deck](models/deck.md) (key: id) — 27 fields, 12 relations
54
- - [discordGuild](models/discordGuild.md) (key: id) — 11 fields, 5 relations
55
- - [discordMember](models/discordMember.md) (key: id) — 9 fields, 1 relations
56
- - [discordProjectNotification](models/discordProjectNotification.md) (key: id) — 6 fields, 2 relations
57
- - [discordSlashCommand](models/discordSlashCommand.md) (key: id) — 15 fields, 2 relations
58
- - [dueCard](models/dueCard.md) (key: userId, cardId) — 4 fields, 3 relations
59
- - [file](models/file.md) (key: id) — 12 fields, 3 relations
36
+ - [card](models/card.md) (key: cardId) — 30 fields, 19 relations
37
+ - [cardHistory](models/cardHistory.md) (key: cardId, version) — 6 fields, 3 relations — **preview**
38
+ - [deck](models/deck.md) (key: id) — 20 fields, 8 relations
39
+ - [file](models/file.md) (key: id) — 7 fields, 2 relations
60
40
  - [handCard](models/handCard.md) (key: cardId, userId, accountId) — 4 fields, 3 relations
61
- - [integration](models/integration.md) (key: id) — 9 fields, 3 relations
62
- - [invoice](models/invoice.md) (key: id) — 9 fields, 1 relations
63
- - [lastSeenCardUpvote](models/lastSeenCardUpvote.md) (key: userId, accountId) — 4 fields, 2 relations
64
- - [milestoneProgress](models/milestoneProgress.md) (key: milestoneId, date) — 2 fields, 1 relations
41
+ - [milestone](models/milestone.md) (key: id) — 16 fields, 6 relations
42
+ - [milestoneProgress](models/milestoneProgress.md) (key: milestoneId, date) — 3 fields, 1 relations — **preview**
65
43
  - [milestoneProject](models/milestoneProject.md) (key: milestoneId, projectId) — 3 fields, 3 relations
66
- - [milestone](models/milestone.md) (key: id) — 18 fields, 7 relations
67
- - [pinnedMilestone](models/pinnedMilestone.md) (key: id) — 7 fields, 4 relations
68
- - [projectOrder](models/projectOrder.md) (key: projectId, userId, accountId) — 4 fields, 3 relations
69
- - [projectSelection](models/projectSelection.md) (key: id) — 4 fields, 3 relations
44
+ - [project](models/project.md) (key: id) — 7 fields, 6 relations
70
45
  - [projectTag](models/projectTag.md) (key: id) — 7 fields, 1 relations
71
- - [projectUserSetting](models/projectUserSetting.md) (key: projectId, userId) — 2 fields, 2 relations
72
- - [projectUser](models/projectUser.md) (key: projectId, userId) — 4 fields, 3 relations
73
- - [project](models/project.md) (key: id) — 24 fields, 17 relations
74
- - [publicProjectInfo](models/publicProjectInfo.md) (key: projectId) — 7 fields, 2 relations
75
- - [publicProjectMembership](models/publicProjectMembership.md) (key: userId, projectId) — 4 fields, 2 relations
76
46
  - [queueEntry](models/queueEntry.md) (key: id) — 7 fields, 3 relations
77
- - [queueSelection](models/queueSelection.md) (key: id) — 5 fields, 3 relations
78
- - [release](models/release.md) (key: id) — 6 fields, 0 relations
79
- - [resolvableEntryHistory](models/resolvableEntryHistory.md) (key: entryId, version) — 6 fields, 3 relations
80
- - [resolvableEntryReaction](models/resolvableEntryReaction.md) (key: id) — 8 fields, 4 relations
81
- - [resolvableEntry](models/resolvableEntry.md) (key: entryId) — 9 fields, 5 relations
82
- - [resolvableNotification](models/resolvableNotification.md) (key: userId, resolvableId) — 14 fields, 5 relations
83
- - [resolvableParticipantHistory](models/resolvableParticipantHistory.md) (key: participantId, resolvableId, version) — 9 fields, 3 relations
84
- - [resolvableParticipant](models/resolvableParticipant.md) (key: participantId, resolvableId) — 10 fields, 4 relations
85
- - [resolvable](models/resolvable.md) (key: id) — 11 fields, 7 relations
86
- - [savedSearch](models/savedSearch.md) (key: id) — 5 fields, 2 relations
87
- - [sprintConfigProgress](models/sprintConfigProgress.md) (key: sprintConfigId, date) — 2 fields, 1 relations
88
- - [sprintConfig](models/sprintConfig.md) (key: id) — 19 fields, 5 relations
89
- - [sprintProgress](models/sprintProgress.md) (key: sprintId, date) — 2 fields, 1 relations
47
+ - [release](models/release.md) (key: id) — 5 fields, 0 relations
48
+ - [resolvable](models/resolvable.md) (key: id) — 9 fields, 6 relations
49
+ - [resolvableEntry](models/resolvableEntry.md) (key: entryId) — 8 fields, 4 relations
50
+ - [resolvableEntryReaction](models/resolvableEntryReaction.md) (key: id) — 7 fields, 4 relations — **preview**
51
+ - [sprint](models/sprint.md) (key: id) — 18 fields, 6 relations
52
+ - [sprintConfig](models/sprintConfig.md) (key: id) — 13 fields, 5 relations
53
+ - [sprintConfigProgress](models/sprintConfigProgress.md) (key: sprintConfigId, date) — 3 fields, 1 relations — **preview**
54
+ - [sprintProgress](models/sprintProgress.md) (key: sprintId, date) — 3 fields, 1 relations — **preview**
90
55
  - [sprintProject](models/sprintProject.md) (key: sprintConfigId, projectId) — 3 fields, 3 relations
91
- - [sprint](models/sprint.md) (key: id) — 20 fields, 8 relations
92
- - [stripeAccountSync](models/stripeAccountSync.md) (key: accountId) — 17 fields, 1 relations
93
- - [timeTrackingSegment](models/timeTrackingSegment.md) (key: id) — 10 fields, 3 relations
94
- - [timeTrackingSum](models/timeTrackingSum.md) (key: cardId, userId) — 5 fields, 2 relations
95
- - [userDismissedHint](models/userDismissedHint.md) (key: userId, hintKey) — 4 fields, 1 relations
96
- - [userEmail](models/userEmail.md) (key: id) — 6 fields, 1 relations
97
- - [userInvitation](models/userInvitation.md) (key: id) — 7 fields, 2 relations
98
- - [userInviteCode](models/userInviteCode.md) (key: id) — 10 fields, 2 relations
99
- - [userOnboarding](models/userOnboarding.md) (key: userId) — 2 fields, 1 relations
100
- - [userProjectAccess](models/userProjectAccess.md) (key: projectId, userId) — 4 fields, 2 relations
101
- - [userTag](models/userTag.md) (key: id) — 5 fields, 2 relations
102
- - [user](models/user.md) (key: id) — 19 fields, 31 relations
103
- - [userReportEmail](models/userReportEmail.md) (key: id) — 6 fields, 2 relations
104
- - [userReportSetting](models/userReportSetting.md) (key: id) — 7 fields, 2 relations
105
- - [userReportToken](models/userReportToken.md) (key: token) — 6 fields, 1 relations
106
- - [visionBoardQuery](models/visionBoardQuery.md) (key: id) — 9 fields, 2 relations
107
- - [visionBoard](models/visionBoard.md) (key: id) — 7 fields, 3 relations
108
- - [wizard](models/wizard.md) (key: id) — 7 fields, 1 relations
109
- - [workflowItemHistory](models/workflowItemHistory.md) (key: itemId, version) — 5 fields, 2 relations
110
- - [workflowItem](models/workflowItem.md) (key: itemId) — 23 fields, 8 relations
56
+ - [user](models/user.md) (key: id) — 7 fields, 1 relations
57
+ - [workflowItem](models/workflowItem.md) (key: itemId) — 22 fields, 7 relations — **preview**
@@ -131,7 +131,7 @@ Pass an array of queries with `as` aliases:
131
131
  fields: ["title"],
132
132
  filter: {
133
133
  assignee: {name: "Alice"}, // cards where assignee.name = "Alice"
134
- "!deck": {isDeleted: "true"}, // negated: cards NOT in deleted decks
134
+ "!milestone": {name: "Alpha"}, // negated: cards NOT in the "Alpha" milestone
135
135
  },
136
136
  },
137
137
  }
@@ -0,0 +1,103 @@
1
+ # Types
2
+
3
+ Named types used by the [models](overview.md#all-models). Each is exported from `@codecks/fetch`.
4
+
5
+ Enums are open unions: `(string & {})` keeps autocompletion for the listed values but admits new ones the API may add.
6
+
7
+ ## CardVisibility
8
+
9
+ ```ts
10
+ type CardVisibility = "default" | "archived" | "deleted" | (string & {});
11
+ ```
12
+
13
+ Used by [`card.visibility`](models/card.md), [`workflowItem.visibility`](models/workflowItem.md).
14
+
15
+ ## Checkbox
16
+
17
+ ```ts
18
+ type Checkbox = {label: string; checked: boolean};
19
+ ```
20
+
21
+ Used by [`card.checkboxInfo`](models/card.md), [`workflowItem.checkboxInfo`](models/workflowItem.md).
22
+
23
+ ## CheckboxStats
24
+
25
+ ```ts
26
+ type CheckboxStats = {total: number; checked: number};
27
+ ```
28
+
29
+ Used by [`card.checkboxStats`](models/card.md), [`workflowItem.checkboxStats`](models/workflowItem.md).
30
+
31
+ ## DefaultCard
32
+
33
+ ```ts
34
+ type DefaultCard = {content?: string; assigneeId?: UserId | null; priority?: Priority | null; effort?: number | null; masterTags?: string[]};
35
+ ```
36
+
37
+ Uses [`UserId`](models/user.md), [`Priority`](types.md#priority).
38
+
39
+ Used by [`deck.defaultCard`](models/deck.md).
40
+
41
+ ## DerivedStatus
42
+
43
+ ```ts
44
+ type DerivedStatus = "deleted" | "archived" | "archivedDone" | "archivedHeroDone" | "doc" | "blocked" | "review" | "hero" | "heroDone" | "heroDoc" | "assigned" | "unassigned" | "started" | "done" | "snoozing" | "archivedHero" | (string & {});
45
+ ```
46
+
47
+ Used by [`card.derivedStatus`](models/card.md).
48
+
49
+ ## MilestoneColor
50
+
51
+ ```ts
52
+ type MilestoneColor = "gray" | "brown" | "yellow" | "red" | "pink" | "blue" | "green" | (string & {});
53
+ ```
54
+
55
+ Used by [`milestone.color`](models/milestone.md), [`sprintConfig.color`](models/sprintConfig.md).
56
+
57
+ ## Priority
58
+
59
+ ```ts
60
+ type Priority = "a" | "b" | "c" | (string & {});
61
+ ```
62
+
63
+ Used by [`card.priority`](models/card.md), [`workflowItem.priority`](models/workflowItem.md).
64
+
65
+ ## StartWeekday
66
+
67
+ ```ts
68
+ type StartWeekday = "monday" | "saturday" | "sunday" | (string & {});
69
+ ```
70
+
71
+ Used by [`account.startWeekday`](models/account.md).
72
+
73
+ ## TimeTrackingMode
74
+
75
+ ```ts
76
+ type TimeTrackingMode = "none" | "manual" | "strict" | (string & {});
77
+ ```
78
+
79
+ Used by [`account.timeTrackingMode`](models/account.md).
80
+
81
+ ## TimelineScaleType
82
+
83
+ ```ts
84
+ type TimelineScaleType = "day" | "week" | (string & {});
85
+ ```
86
+
87
+ Used by [`account.timelineScaleType`](models/account.md).
88
+
89
+ ## Workdays
90
+
91
+ ```ts
92
+ type Workdays = {monday: boolean; tuesday: boolean; wednesday: boolean; thursday: boolean; friday: boolean; saturday: boolean; sunday: boolean};
93
+ ```
94
+
95
+ Used by [`account.workdays`](models/account.md).
96
+
97
+ ## WorkflowMode
98
+
99
+ ```ts
100
+ type WorkflowMode = "none" | "only_parent_cards" | "journeys" | (string & {});
101
+ ```
102
+
103
+ Used by [`account.workflowMode`](models/account.md).
@@ -1,34 +0,0 @@
1
- import { ModelDesc, RelationEntry } from "./query-type-BqQ9oX_U.js";
2
-
3
- //#region src/models/_root.d.ts
4
- declare const _rootDesc: ModelDesc<"_root", {}, {
5
- releases: RelationEntry<"release", {
6
- readonly type: "hasMany";
7
- }>;
8
- accountOnboardingSteps: RelationEntry<"accountOnboardingStep", {
9
- readonly type: "hasMany";
10
- }>;
11
- apps: RelationEntry<"app", {
12
- readonly type: "hasMany";
13
- }>;
14
- account: RelationEntry<"account", {
15
- readonly type: "hasOne";
16
- }>;
17
- loggedInUser: RelationEntry<"user", {
18
- readonly type: "hasOne";
19
- }>;
20
- cardsStatusHistory: RelationEntry<"cardsStatusHistory", {
21
- readonly type: "hasMany";
22
- }>;
23
- cardsEffortHistory: RelationEntry<"cardsEffortHistory", {
24
- readonly type: "hasMany";
25
- }>;
26
- cardsFinishedHistory: RelationEntry<"cardsFinishedHistory", {
27
- readonly type: "hasMany";
28
- }>;
29
- cardsTimeToFinished: RelationEntry<"cardsTimeToFinished", {
30
- readonly type: "hasMany";
31
- }>;
32
- }, []>;
33
- //#endregion
34
- export { _rootDesc as _rootDesc$1 };