@uidu/client 3.11.0 → 3.12.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.
- package/CHANGELOG.md +6 -0
- package/dist/declarations/src/generated/index.d.ts +264 -3
- package/dist/declarations/src/goals.d.ts +127 -0
- package/dist/declarations/src/index.d.ts +3 -1
- package/dist/uidu-client.cjs.dev.js +101 -1
- package/dist/uidu-client.cjs.prod.js +101 -1
- package/dist/uidu-client.esm.js +91 -2
- package/package.json +1 -1
- package/src/generated/index.ts +87 -3
- package/src/goals.test.ts +90 -0
- package/src/goals.ts +144 -0
- package/src/index.ts +14 -0
- package/src/queries/goals/GetGoal.graphql +14 -0
- package/src/queries/goals/GoalFields.graphql +28 -0
- package/src/queries/goals/GoalMutations.graphql +12 -0
- package/src/queries/goals/ListGoals.graphql +15 -0
- package/src/queries/goals/ListTimeframes.graphql +20 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# @uidu/client
|
|
2
2
|
|
|
3
|
+
## 3.12.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 38800c8: Read the workspace's goals (OKRs). `@uidu/client` adds `listGoals`, `getGoal`, `listTimeframes` and `updateGoal`, plus `goalValue` / `toGoalRaw` / `goalProgress` / `goalTimeElapsed` / `isGoalBehind` for values uidu stores x100. The CLI gets `goals` and `timeframes`. Inside a custom app the session token can now read goals and timeframes (read-only), and the `uidu` skill gains a "Workspace data" section: read what the workspace already holds, create a Model only for data uidu has no place for, and the valid field kinds for `ensureModel`.
|
|
8
|
+
|
|
3
9
|
## 3.11.0
|
|
4
10
|
|
|
5
11
|
### Minor Changes
|
|
@@ -28513,6 +28513,8 @@ export type Mutation = Node & {
|
|
|
28513
28513
|
reorderWorkflowStep?: Maybe<ReorderWorkflowStepPayload>;
|
|
28514
28514
|
reorderWorkflowStepItem?: Maybe<ReorderWorkflowStepItemPayload>;
|
|
28515
28515
|
replaceDocumentAttachment?: Maybe<ReplaceDocumentAttachmentPayload>;
|
|
28516
|
+
/** Replace the format of an owner for one purpose with an ordered list of parts */
|
|
28517
|
+
replaceNameFormatParts?: Maybe<ReplaceNameFormatPartsPayload>;
|
|
28516
28518
|
replayWebhookDelivery?: Maybe<ReplayWebhookDeliveryPayload>;
|
|
28517
28519
|
requestReward?: Maybe<RequestRewardPayload>;
|
|
28518
28520
|
resendInvitation?: Maybe<ResendInvitationPayload>;
|
|
@@ -30619,6 +30621,9 @@ export type MutationReorderWorkflowStepItemArgs = {
|
|
|
30619
30621
|
export type MutationReplaceDocumentAttachmentArgs = {
|
|
30620
30622
|
input: ReplaceDocumentAttachmentInput;
|
|
30621
30623
|
};
|
|
30624
|
+
export type MutationReplaceNameFormatPartsArgs = {
|
|
30625
|
+
input: ReplaceNameFormatPartsInput;
|
|
30626
|
+
};
|
|
30622
30627
|
export type MutationReplayWebhookDeliveryArgs = {
|
|
30623
30628
|
input: ReplayWebhookDeliveryInput;
|
|
30624
30629
|
};
|
|
@@ -31555,6 +31560,8 @@ export type MutationVerifyInboxDomainArgs = {
|
|
|
31555
31560
|
export type MutationVoidSignatureRequestArgs = {
|
|
31556
31561
|
input: VoidSignatureRequestInput;
|
|
31557
31562
|
};
|
|
31563
|
+
/** Objects which may own a name format */
|
|
31564
|
+
export type NameFormatOwner = DocumentModel | Product | WorkspaceApp;
|
|
31558
31565
|
/** One token of a composed name: a field, a token or a literal */
|
|
31559
31566
|
export type NameFormatPart = ActiveRecordTimestamp & Node & {
|
|
31560
31567
|
__typename?: 'NameFormatPart';
|
|
@@ -31587,15 +31594,18 @@ export type NameFormatPartAttributes = {
|
|
|
31587
31594
|
ifFalse?: InputMaybe<Scalars['String']['input']>;
|
|
31588
31595
|
/** Text used for a true value, with the boolean transformer */
|
|
31589
31596
|
ifTrue?: InputMaybe<Scalars['String']['input']>;
|
|
31590
|
-
/** The token to resolve, for kind token (
|
|
31597
|
+
/** The token to resolve, for kind token (contact.lastName, createdAt; year, month, day, number for a code) */
|
|
31591
31598
|
key?: InputMaybe<Scalars['String']['input']>;
|
|
31592
31599
|
/** field | token | literal */
|
|
31593
31600
|
kind?: InputMaybe<Scalars['String']['input']>;
|
|
31594
|
-
/**
|
|
31601
|
+
/**
|
|
31602
|
+
* The record whose format this part belongs to: a document model, the inventory
|
|
31603
|
+
* app (delivery and transfer codes) or a product (sku codes)
|
|
31604
|
+
*/
|
|
31595
31605
|
ownerId?: InputMaybe<Scalars['ID']['input']>;
|
|
31596
31606
|
/** Order of the part within its format, from 0 */
|
|
31597
31607
|
position?: InputMaybe<Scalars['Int']['input']>;
|
|
31598
|
-
/** Which name the parts compose
|
|
31608
|
+
/** Which name the parts compose: document_name, delivery_code, transfer_code or sku_code */
|
|
31599
31609
|
purpose?: InputMaybe<Scalars['String']['input']>;
|
|
31600
31610
|
/** Transformer applied to the resolved value (uppercase, date, fill, …) */
|
|
31601
31611
|
transformer?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -34452,6 +34462,8 @@ export type Product = ActiveRecordTimestamp & ActsAsFormable & Node & WithCampai
|
|
|
34452
34462
|
memberList: Array<User>;
|
|
34453
34463
|
members: UserConnection;
|
|
34454
34464
|
name?: Maybe<Scalars['String']['output']>;
|
|
34465
|
+
/** How a new sku of this product is coded, in order */
|
|
34466
|
+
nameFormatParts: Array<NameFormatPart>;
|
|
34455
34467
|
orderItems?: Maybe<Array<OrderItem>>;
|
|
34456
34468
|
orderList: Array<Order>;
|
|
34457
34469
|
orders: OrderConnection;
|
|
@@ -37147,6 +37159,29 @@ export type ReplaceDocumentAttachmentPayload = {
|
|
|
37147
37159
|
document?: Maybe<Document>;
|
|
37148
37160
|
errors: Array<Error>;
|
|
37149
37161
|
};
|
|
37162
|
+
/** Autogenerated input type of ReplaceNameFormatParts */
|
|
37163
|
+
export type ReplaceNameFormatPartsInput = {
|
|
37164
|
+
/** Flag to mark the object for destruction */
|
|
37165
|
+
_destroy?: InputMaybe<Scalars['Boolean']['input']>;
|
|
37166
|
+
/** A unique identifier for the client performing the mutation. */
|
|
37167
|
+
clientMutationId?: InputMaybe<Scalars['String']['input']>;
|
|
37168
|
+
/** Global ID of the object */
|
|
37169
|
+
id?: InputMaybe<Scalars['ID']['input']>;
|
|
37170
|
+
ownerId: Scalars['ID']['input'];
|
|
37171
|
+
/** The parts, in order; position comes from the order */
|
|
37172
|
+
parts: Array<NameFormatPartAttributes>;
|
|
37173
|
+
/** document_name, delivery_code, transfer_code or sku_code */
|
|
37174
|
+
purpose: Scalars['String']['input'];
|
|
37175
|
+
};
|
|
37176
|
+
/** Autogenerated return type of ReplaceNameFormatParts. */
|
|
37177
|
+
export type ReplaceNameFormatPartsPayload = {
|
|
37178
|
+
__typename?: 'ReplaceNameFormatPartsPayload';
|
|
37179
|
+
/** A unique identifier for the client performing the mutation. */
|
|
37180
|
+
clientMutationId?: Maybe<Scalars['String']['output']>;
|
|
37181
|
+
errors: Array<Error>;
|
|
37182
|
+
nameFormatParts?: Maybe<Array<NameFormatPart>>;
|
|
37183
|
+
owner?: Maybe<NameFormatOwner>;
|
|
37184
|
+
};
|
|
37150
37185
|
/** Autogenerated input type of ReplayWebhookDelivery */
|
|
37151
37186
|
export type ReplayWebhookDeliveryInput = {
|
|
37152
37187
|
/** Flag to mark the object for destruction */
|
|
@@ -53658,6 +53693,8 @@ export type WorkspaceApp = ActiveRecordTimestamp & Node & Showcase & WithDataVie
|
|
|
53658
53693
|
modelList?: Maybe<Array<Model>>;
|
|
53659
53694
|
models?: Maybe<ModelConnection>;
|
|
53660
53695
|
name?: Maybe<Scalars['String']['output']>;
|
|
53696
|
+
/** How the codes of this app are composed, in order */
|
|
53697
|
+
nameFormatParts: Array<NameFormatPart>;
|
|
53661
53698
|
newCycleSuggestedStartDate?: Maybe<Scalars['ISO8601Date']['output']>;
|
|
53662
53699
|
openTasksCount: Scalars['Int']['output'];
|
|
53663
53700
|
owner: WorkspaceAppOwner;
|
|
@@ -53762,6 +53799,9 @@ export type WorkspaceAppModelsArgs = {
|
|
|
53762
53799
|
first?: InputMaybe<Scalars['Int']['input']>;
|
|
53763
53800
|
last?: InputMaybe<Scalars['Int']['input']>;
|
|
53764
53801
|
};
|
|
53802
|
+
export type WorkspaceAppNameFormatPartsArgs = {
|
|
53803
|
+
purpose?: InputMaybe<Scalars['String']['input']>;
|
|
53804
|
+
};
|
|
53765
53805
|
export type WorkspaceAppPersonalDataViewsArgs = {
|
|
53766
53806
|
after?: InputMaybe<Scalars['String']['input']>;
|
|
53767
53807
|
before?: InputMaybe<Scalars['String']['input']>;
|
|
@@ -56358,6 +56398,222 @@ export type UpdateFormResponseMutation = {
|
|
|
56358
56398
|
} | null;
|
|
56359
56399
|
} | null;
|
|
56360
56400
|
};
|
|
56401
|
+
export type GetGoalQueryVariables = Exact<{
|
|
56402
|
+
id: Scalars['ID']['input'];
|
|
56403
|
+
}>;
|
|
56404
|
+
export type GetGoalQuery = {
|
|
56405
|
+
__typename?: 'Query';
|
|
56406
|
+
currentWorkspace?: {
|
|
56407
|
+
__typename?: 'Workspace';
|
|
56408
|
+
goal?: {
|
|
56409
|
+
__typename?: 'Goal';
|
|
56410
|
+
id: string;
|
|
56411
|
+
name?: string | null;
|
|
56412
|
+
description?: any | null;
|
|
56413
|
+
kind?: GoalKind | null;
|
|
56414
|
+
metricKind?: string | null;
|
|
56415
|
+
status?: string | null;
|
|
56416
|
+
currency?: string | null;
|
|
56417
|
+
initialValue?: number | null;
|
|
56418
|
+
currentValue?: number | null;
|
|
56419
|
+
targetValue?: number | null;
|
|
56420
|
+
progress?: number | null;
|
|
56421
|
+
weight?: number | null;
|
|
56422
|
+
updateFrequency?: string | null;
|
|
56423
|
+
parentId?: string | null;
|
|
56424
|
+
subgoalsCount?: number | null;
|
|
56425
|
+
createdAt: any;
|
|
56426
|
+
updatedAt: any;
|
|
56427
|
+
subgoals?: {
|
|
56428
|
+
__typename?: 'GoalConnection';
|
|
56429
|
+
edges?: Array<{
|
|
56430
|
+
__typename?: 'GoalEdge';
|
|
56431
|
+
node?: {
|
|
56432
|
+
__typename?: 'Goal';
|
|
56433
|
+
id: string;
|
|
56434
|
+
name?: string | null;
|
|
56435
|
+
description?: any | null;
|
|
56436
|
+
kind?: GoalKind | null;
|
|
56437
|
+
metricKind?: string | null;
|
|
56438
|
+
status?: string | null;
|
|
56439
|
+
currency?: string | null;
|
|
56440
|
+
initialValue?: number | null;
|
|
56441
|
+
currentValue?: number | null;
|
|
56442
|
+
targetValue?: number | null;
|
|
56443
|
+
progress?: number | null;
|
|
56444
|
+
weight?: number | null;
|
|
56445
|
+
updateFrequency?: string | null;
|
|
56446
|
+
parentId?: string | null;
|
|
56447
|
+
subgoalsCount?: number | null;
|
|
56448
|
+
createdAt: any;
|
|
56449
|
+
updatedAt: any;
|
|
56450
|
+
timeframe?: {
|
|
56451
|
+
__typename?: 'Timeframe';
|
|
56452
|
+
id: string;
|
|
56453
|
+
name?: string | null;
|
|
56454
|
+
startDate?: any | null;
|
|
56455
|
+
endDate?: any | null;
|
|
56456
|
+
} | null;
|
|
56457
|
+
} | null;
|
|
56458
|
+
} | null> | null;
|
|
56459
|
+
} | null;
|
|
56460
|
+
timeframe?: {
|
|
56461
|
+
__typename?: 'Timeframe';
|
|
56462
|
+
id: string;
|
|
56463
|
+
name?: string | null;
|
|
56464
|
+
startDate?: any | null;
|
|
56465
|
+
endDate?: any | null;
|
|
56466
|
+
} | null;
|
|
56467
|
+
} | null;
|
|
56468
|
+
} | null;
|
|
56469
|
+
};
|
|
56470
|
+
export type GoalFieldsFragment = {
|
|
56471
|
+
__typename?: 'Goal';
|
|
56472
|
+
id: string;
|
|
56473
|
+
name?: string | null;
|
|
56474
|
+
description?: any | null;
|
|
56475
|
+
kind?: GoalKind | null;
|
|
56476
|
+
metricKind?: string | null;
|
|
56477
|
+
status?: string | null;
|
|
56478
|
+
currency?: string | null;
|
|
56479
|
+
initialValue?: number | null;
|
|
56480
|
+
currentValue?: number | null;
|
|
56481
|
+
targetValue?: number | null;
|
|
56482
|
+
progress?: number | null;
|
|
56483
|
+
weight?: number | null;
|
|
56484
|
+
updateFrequency?: string | null;
|
|
56485
|
+
parentId?: string | null;
|
|
56486
|
+
subgoalsCount?: number | null;
|
|
56487
|
+
createdAt: any;
|
|
56488
|
+
updatedAt: any;
|
|
56489
|
+
timeframe?: {
|
|
56490
|
+
__typename?: 'Timeframe';
|
|
56491
|
+
id: string;
|
|
56492
|
+
name?: string | null;
|
|
56493
|
+
startDate?: any | null;
|
|
56494
|
+
endDate?: any | null;
|
|
56495
|
+
} | null;
|
|
56496
|
+
};
|
|
56497
|
+
export type UpdateGoalMutationVariables = Exact<{
|
|
56498
|
+
input: UpdateGoalInput;
|
|
56499
|
+
}>;
|
|
56500
|
+
export type UpdateGoalMutation = {
|
|
56501
|
+
__typename?: 'Mutation';
|
|
56502
|
+
updateGoal?: {
|
|
56503
|
+
__typename?: 'UpdateGoalPayload';
|
|
56504
|
+
goal?: {
|
|
56505
|
+
__typename?: 'Goal';
|
|
56506
|
+
id: string;
|
|
56507
|
+
name?: string | null;
|
|
56508
|
+
description?: any | null;
|
|
56509
|
+
kind?: GoalKind | null;
|
|
56510
|
+
metricKind?: string | null;
|
|
56511
|
+
status?: string | null;
|
|
56512
|
+
currency?: string | null;
|
|
56513
|
+
initialValue?: number | null;
|
|
56514
|
+
currentValue?: number | null;
|
|
56515
|
+
targetValue?: number | null;
|
|
56516
|
+
progress?: number | null;
|
|
56517
|
+
weight?: number | null;
|
|
56518
|
+
updateFrequency?: string | null;
|
|
56519
|
+
parentId?: string | null;
|
|
56520
|
+
subgoalsCount?: number | null;
|
|
56521
|
+
createdAt: any;
|
|
56522
|
+
updatedAt: any;
|
|
56523
|
+
timeframe?: {
|
|
56524
|
+
__typename?: 'Timeframe';
|
|
56525
|
+
id: string;
|
|
56526
|
+
name?: string | null;
|
|
56527
|
+
startDate?: any | null;
|
|
56528
|
+
endDate?: any | null;
|
|
56529
|
+
} | null;
|
|
56530
|
+
} | null;
|
|
56531
|
+
errors: Array<{
|
|
56532
|
+
__typename?: 'Error';
|
|
56533
|
+
key: string;
|
|
56534
|
+
name: string;
|
|
56535
|
+
type: string;
|
|
56536
|
+
}>;
|
|
56537
|
+
} | null;
|
|
56538
|
+
};
|
|
56539
|
+
export type ListGoalsQueryVariables = Exact<{
|
|
56540
|
+
first?: InputMaybe<Scalars['Int']['input']>;
|
|
56541
|
+
after?: InputMaybe<Scalars['String']['input']>;
|
|
56542
|
+
}>;
|
|
56543
|
+
export type ListGoalsQuery = {
|
|
56544
|
+
__typename?: 'Query';
|
|
56545
|
+
currentWorkspace?: {
|
|
56546
|
+
__typename?: 'Workspace';
|
|
56547
|
+
goals: {
|
|
56548
|
+
__typename?: 'GoalConnection';
|
|
56549
|
+
pageInfo: {
|
|
56550
|
+
__typename?: 'PageInfo';
|
|
56551
|
+
hasNextPage: boolean;
|
|
56552
|
+
endCursor?: string | null;
|
|
56553
|
+
};
|
|
56554
|
+
edges?: Array<{
|
|
56555
|
+
__typename?: 'GoalEdge';
|
|
56556
|
+
node?: {
|
|
56557
|
+
__typename?: 'Goal';
|
|
56558
|
+
id: string;
|
|
56559
|
+
name?: string | null;
|
|
56560
|
+
description?: any | null;
|
|
56561
|
+
kind?: GoalKind | null;
|
|
56562
|
+
metricKind?: string | null;
|
|
56563
|
+
status?: string | null;
|
|
56564
|
+
currency?: string | null;
|
|
56565
|
+
initialValue?: number | null;
|
|
56566
|
+
currentValue?: number | null;
|
|
56567
|
+
targetValue?: number | null;
|
|
56568
|
+
progress?: number | null;
|
|
56569
|
+
weight?: number | null;
|
|
56570
|
+
updateFrequency?: string | null;
|
|
56571
|
+
parentId?: string | null;
|
|
56572
|
+
subgoalsCount?: number | null;
|
|
56573
|
+
createdAt: any;
|
|
56574
|
+
updatedAt: any;
|
|
56575
|
+
timeframe?: {
|
|
56576
|
+
__typename?: 'Timeframe';
|
|
56577
|
+
id: string;
|
|
56578
|
+
name?: string | null;
|
|
56579
|
+
startDate?: any | null;
|
|
56580
|
+
endDate?: any | null;
|
|
56581
|
+
} | null;
|
|
56582
|
+
} | null;
|
|
56583
|
+
} | null> | null;
|
|
56584
|
+
};
|
|
56585
|
+
} | null;
|
|
56586
|
+
};
|
|
56587
|
+
export type ListTimeframesQueryVariables = Exact<{
|
|
56588
|
+
first?: InputMaybe<Scalars['Int']['input']>;
|
|
56589
|
+
after?: InputMaybe<Scalars['String']['input']>;
|
|
56590
|
+
}>;
|
|
56591
|
+
export type ListTimeframesQuery = {
|
|
56592
|
+
__typename?: 'Query';
|
|
56593
|
+
currentWorkspace?: {
|
|
56594
|
+
__typename?: 'Workspace';
|
|
56595
|
+
timeframes: {
|
|
56596
|
+
__typename?: 'TimeframeConnection';
|
|
56597
|
+
pageInfo: {
|
|
56598
|
+
__typename?: 'PageInfo';
|
|
56599
|
+
hasNextPage: boolean;
|
|
56600
|
+
endCursor?: string | null;
|
|
56601
|
+
};
|
|
56602
|
+
edges?: Array<{
|
|
56603
|
+
__typename?: 'TimeframeEdge';
|
|
56604
|
+
node?: {
|
|
56605
|
+
__typename?: 'Timeframe';
|
|
56606
|
+
id: string;
|
|
56607
|
+
name?: string | null;
|
|
56608
|
+
startDate?: any | null;
|
|
56609
|
+
endDate?: any | null;
|
|
56610
|
+
year?: number | null;
|
|
56611
|
+
active?: boolean | null;
|
|
56612
|
+
} | null;
|
|
56613
|
+
} | null> | null;
|
|
56614
|
+
};
|
|
56615
|
+
} | null;
|
|
56616
|
+
};
|
|
56361
56617
|
export type CreateChannelMutationVariables = Exact<{
|
|
56362
56618
|
input: CreateChannelInput;
|
|
56363
56619
|
}>;
|
|
@@ -66165,6 +66421,7 @@ export type DeleteTaskMutation = {
|
|
|
66165
66421
|
};
|
|
66166
66422
|
export declare const FormFieldsFragmentDoc: DocumentNode<FormFieldsFragment, unknown>;
|
|
66167
66423
|
export declare const FormResponseFieldsFragmentDoc: DocumentNode<FormResponseFieldsFragment, unknown>;
|
|
66424
|
+
export declare const GoalFieldsFragmentDoc: DocumentNode<GoalFieldsFragment, unknown>;
|
|
66168
66425
|
export declare const ModelFieldOptionFragmentDoc: DocumentNode<ModelFieldOptionFragment, unknown>;
|
|
66169
66426
|
export declare const ModelFieldFragmentDoc: DocumentNode<ModelFieldFragment, unknown>;
|
|
66170
66427
|
export declare const ModelSchemaFragmentDoc: DocumentNode<ModelSchemaFragment, unknown>;
|
|
@@ -66233,6 +66490,10 @@ export declare const DeleteFormDocument: DocumentNode<DeleteFormMutation, Delete
|
|
|
66233
66490
|
export declare const GetFormDocument: DocumentNode<GetFormQuery, GetFormQueryVariables>;
|
|
66234
66491
|
export declare const ListFormsDocument: DocumentNode<ListFormsQuery, ListFormsQueryVariables>;
|
|
66235
66492
|
export declare const UpdateFormResponseDocument: DocumentNode<UpdateFormResponseMutation, UpdateFormResponseMutationVariables>;
|
|
66493
|
+
export declare const GetGoalDocument: DocumentNode<GetGoalQuery, GetGoalQueryVariables>;
|
|
66494
|
+
export declare const UpdateGoalDocument: DocumentNode<UpdateGoalMutation, UpdateGoalMutationVariables>;
|
|
66495
|
+
export declare const ListGoalsDocument: DocumentNode<ListGoalsQuery, ListGoalsQueryVariables>;
|
|
66496
|
+
export declare const ListTimeframesDocument: DocumentNode<ListTimeframesQuery, ListTimeframesQueryVariables>;
|
|
66236
66497
|
export declare const CreateChannelDocument: DocumentNode<CreateChannelMutation, CreateChannelMutationVariables>;
|
|
66237
66498
|
export declare const UpdateChannelDocument: DocumentNode<UpdateChannelMutation, UpdateChannelMutationVariables>;
|
|
66238
66499
|
export declare const DeleteChannelDocument: DocumentNode<DeleteChannelMutation, DeleteChannelMutationVariables>;
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import type { UiduClient } from "./client.js";
|
|
2
|
+
import { type GetGoalQuery, type GetGoalQueryVariables, type ListGoalsQueryVariables, type ListTimeframesQuery, type ListTimeframesQueryVariables, type UpdateGoalMutationVariables } from "./generated/index.js";
|
|
3
|
+
export type Goal = NonNullable<NonNullable<GetGoalQuery['currentWorkspace']>['goal']>;
|
|
4
|
+
export type Timeframe = NonNullable<NonNullable<NonNullable<NonNullable<ListTimeframesQuery['currentWorkspace']>['timeframes']>['edges']>[number]>['node'];
|
|
5
|
+
/** Every goal of the workspace (objectives and key results alike), newest first. Without `first`, all of them. */
|
|
6
|
+
export declare function listGoals(client: UiduClient, variables?: ListGoalsQueryVariables): Promise<{
|
|
7
|
+
__typename?: "Goal";
|
|
8
|
+
id: string;
|
|
9
|
+
name?: string | null;
|
|
10
|
+
description?: any | null;
|
|
11
|
+
kind?: import("./generated/index.js").GoalKind | null;
|
|
12
|
+
metricKind?: string | null;
|
|
13
|
+
status?: string | null;
|
|
14
|
+
currency?: string | null;
|
|
15
|
+
initialValue?: number | null;
|
|
16
|
+
currentValue?: number | null;
|
|
17
|
+
targetValue?: number | null;
|
|
18
|
+
progress?: number | null;
|
|
19
|
+
weight?: number | null;
|
|
20
|
+
updateFrequency?: string | null;
|
|
21
|
+
parentId?: string | null;
|
|
22
|
+
subgoalsCount?: number | null;
|
|
23
|
+
createdAt: any;
|
|
24
|
+
updatedAt: any;
|
|
25
|
+
timeframe?: {
|
|
26
|
+
__typename?: "Timeframe";
|
|
27
|
+
id: string;
|
|
28
|
+
name?: string | null;
|
|
29
|
+
startDate?: any | null;
|
|
30
|
+
endDate?: any | null;
|
|
31
|
+
} | null;
|
|
32
|
+
}[]>;
|
|
33
|
+
/** One goal with its key results (`subgoals`). */
|
|
34
|
+
export declare function getGoal(client: UiduClient, variables: GetGoalQueryVariables): Promise<Goal | null>;
|
|
35
|
+
export declare function listTimeframes(client: UiduClient, variables?: ListTimeframesQueryVariables): Promise<{
|
|
36
|
+
__typename?: "Timeframe";
|
|
37
|
+
id: string;
|
|
38
|
+
name?: string | null;
|
|
39
|
+
startDate?: any | null;
|
|
40
|
+
endDate?: any | null;
|
|
41
|
+
year?: number | null;
|
|
42
|
+
active?: boolean | null;
|
|
43
|
+
}[]>;
|
|
44
|
+
/**
|
|
45
|
+
* Authoring (Bearer / apiKey). Returns the payload, incl. `errors`.
|
|
46
|
+
* `initialValue` / `currentValue` / `targetValue` are stored x100: pass
|
|
47
|
+
* `toGoalRaw(value)`, never the number a person typed.
|
|
48
|
+
*/
|
|
49
|
+
export declare function updateGoal(client: UiduClient, variables: UpdateGoalMutationVariables): Promise<{
|
|
50
|
+
__typename?: "UpdateGoalPayload";
|
|
51
|
+
goal?: {
|
|
52
|
+
__typename?: "Goal";
|
|
53
|
+
id: string;
|
|
54
|
+
name?: string | null;
|
|
55
|
+
description?: any | null;
|
|
56
|
+
kind?: import("./generated/index.js").GoalKind | null;
|
|
57
|
+
metricKind?: string | null;
|
|
58
|
+
status?: string | null;
|
|
59
|
+
currency?: string | null;
|
|
60
|
+
initialValue?: number | null;
|
|
61
|
+
currentValue?: number | null;
|
|
62
|
+
targetValue?: number | null;
|
|
63
|
+
progress?: number | null;
|
|
64
|
+
weight?: number | null;
|
|
65
|
+
updateFrequency?: string | null;
|
|
66
|
+
parentId?: string | null;
|
|
67
|
+
subgoalsCount?: number | null;
|
|
68
|
+
createdAt: any;
|
|
69
|
+
updatedAt: any;
|
|
70
|
+
timeframe?: {
|
|
71
|
+
__typename?: "Timeframe";
|
|
72
|
+
id: string;
|
|
73
|
+
name?: string | null;
|
|
74
|
+
startDate?: any | null;
|
|
75
|
+
endDate?: any | null;
|
|
76
|
+
} | null;
|
|
77
|
+
} | null;
|
|
78
|
+
errors: Array<{
|
|
79
|
+
__typename?: "Error";
|
|
80
|
+
key: string;
|
|
81
|
+
name: string;
|
|
82
|
+
type: string;
|
|
83
|
+
}>;
|
|
84
|
+
} | null>;
|
|
85
|
+
type GoalMetric = {
|
|
86
|
+
metricKind?: string | null;
|
|
87
|
+
};
|
|
88
|
+
/**
|
|
89
|
+
* A stored goal value (`initialValue`, `currentValue`, `targetValue`) in the
|
|
90
|
+
* unit a person typed: uidu keeps every one of them x100. For `percentage`
|
|
91
|
+
* that is percent points (45 = 45%), for `currency` whole units of
|
|
92
|
+
* `goal.currency`, for `checkbox` 1 or 0. `null` stays `null`.
|
|
93
|
+
*/
|
|
94
|
+
export declare function goalValue(goal: GoalMetric, raw: number | null | undefined): number | null;
|
|
95
|
+
/** The inverse of `goalValue`, for `updateGoal`. */
|
|
96
|
+
export declare function toGoalRaw(value: number): number;
|
|
97
|
+
/**
|
|
98
|
+
* How far the goal is, 0 to 1 (above 1 when it overshoots). `goal.progress`
|
|
99
|
+
* itself is percent x100: 10000 is done.
|
|
100
|
+
*/
|
|
101
|
+
export declare function goalProgress(goal: {
|
|
102
|
+
progress?: number | null;
|
|
103
|
+
}): number;
|
|
104
|
+
/**
|
|
105
|
+
* How much of the goal's timeframe has passed, 0 to 1, or `null` when it has
|
|
106
|
+
* none. A goal whose `goalProgress` is below this is behind schedule.
|
|
107
|
+
*/
|
|
108
|
+
export declare function goalTimeElapsed(goal: {
|
|
109
|
+
timeframe?: {
|
|
110
|
+
startDate?: string | null;
|
|
111
|
+
endDate?: string | null;
|
|
112
|
+
} | null;
|
|
113
|
+
}, now?: Date): number | null;
|
|
114
|
+
/**
|
|
115
|
+
* Behind schedule: less done than time elapsed, by more than `tolerance`
|
|
116
|
+
* (0.1 = ten points). `false` for a goal with no timeframe or one already
|
|
117
|
+
* accomplished. The goal's own `status` (`off_track`, `needs_attention`) is
|
|
118
|
+
* its owner's judgement — show it next to this, don't replace one with the other.
|
|
119
|
+
*/
|
|
120
|
+
export declare function isGoalBehind(goal: Parameters<typeof goalTimeElapsed>[0] & {
|
|
121
|
+
progress?: number | null;
|
|
122
|
+
status?: string | null;
|
|
123
|
+
}, { now, tolerance }?: {
|
|
124
|
+
now?: Date;
|
|
125
|
+
tolerance?: number;
|
|
126
|
+
}): boolean;
|
|
127
|
+
export {};
|
|
@@ -4,7 +4,7 @@ export type { UiduClientConfig, UiduErrorOptions } from "./types.js";
|
|
|
4
4
|
export { paginate } from "./utils/paginate.js";
|
|
5
5
|
export type { PaginateOptions } from "./utils/paginate.js";
|
|
6
6
|
export { normalizeFieldValueContent, normalizeFieldValuesAttributes, } from "./utils/fieldValues.js";
|
|
7
|
-
export { ListApplicationsDocument, ListBookingsDocument, ListCalendarsDocument, ListCalendarEventsDocument, ListCallsDocument, ListCampaignsDocument, ListEmailCampaignsDocument, ListCoursesDocument, ListDealsDocument, ListDonationCampaignsDocument, ListEmployeesDocument, ListEnrollmentsDocument, ListEventsDocument, ListFormsDocument, ListKbArticlesDocument, ListKbCollectionsDocument, ListLecturesDocument, ListPagesDocument, ListStoriesDocument, } from "./generated/index.js";
|
|
7
|
+
export { ListApplicationsDocument, ListBookingsDocument, ListCalendarsDocument, ListCalendarEventsDocument, ListCallsDocument, ListCampaignsDocument, ListEmailCampaignsDocument, ListCoursesDocument, ListDealsDocument, ListDonationCampaignsDocument, ListEmployeesDocument, ListEnrollmentsDocument, ListEventsDocument, ListFormsDocument, ListGoalsDocument, ListKbArticlesDocument, ListKbCollectionsDocument, ListLecturesDocument, ListPagesDocument, ListStoriesDocument, ListTimeframesDocument, } from "./generated/index.js";
|
|
8
8
|
export { getPage, listPages, getTemplate, createProject, createPage, createPageBlock, createFieldValue, listProjects, } from "./cms.js";
|
|
9
9
|
export type { Page, Template } from "./cms.js";
|
|
10
10
|
export { getSiteByDomain, getSite, getPageBySlug, listSitePages, getSingletonBlock, } from "./sites.js";
|
|
@@ -45,6 +45,8 @@ export { getCampaign, listCampaigns, listEmailCampaigns } from "./campaigns.js";
|
|
|
45
45
|
export type { Campaign } from "./campaigns.js";
|
|
46
46
|
export { getContact, listContacts, getDeal, listDeals } from "./contacts.js";
|
|
47
47
|
export type { Contact, Deal } from "./contacts.js";
|
|
48
|
+
export { listGoals, getGoal, listTimeframes, updateGoal, goalValue, toGoalRaw, goalProgress, goalTimeElapsed, isGoalBehind, } from "./goals.js";
|
|
49
|
+
export type { Goal, Timeframe } from "./goals.js";
|
|
48
50
|
export { getKbArticle, listKbArticles, getKbCollection, listKbCollections, } from "./kb.js";
|
|
49
51
|
export type { KbArticle, KbCollection } from "./kb.js";
|
|
50
52
|
export { listModels, getModel, listModelItems, getModelItem, createModel, updateModel, createField, updateField, deleteField, createFieldOption, updateFieldOption, deleteFieldOption, createModelItem, updateModelItem, deleteModelItem, updateFieldValue, deleteFieldValue, toFieldValuesAttributes, ensureModel, } from "./models.js";
|