studiokit-scaffolding-js 4.3.20 → 4.3.21
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/LICENSE +21 -21
- package/README.md +127 -127
- package/lib/components/ActionList.d.ts +20 -20
- package/lib/components/ActionList.js +94 -94
- package/lib/components/AlertDialog.d.ts +18 -18
- package/lib/components/AlertDialog.js +21 -21
- package/lib/components/AlertWithIcon.d.ts +7 -7
- package/lib/components/AlertWithIcon.js +57 -57
- package/lib/components/Blots/CustomImageSpec.d.ts +14 -14
- package/lib/components/Blots/CustomImageSpec.js +45 -45
- package/lib/components/Blots/CustomVideoSpec.d.ts +16 -16
- package/lib/components/Blots/CustomVideoSpec.js +47 -47
- package/lib/components/ConnectedModal.d.ts +6 -6
- package/lib/components/ConnectedModal.js +11 -11
- package/lib/components/Dropdowns/GroupsDropdown.d.ts +18 -18
- package/lib/components/Dropdowns/GroupsDropdown.js +90 -90
- package/lib/components/Dropdowns/ManagedNavDropdown.d.ts +32 -32
- package/lib/components/Dropdowns/ManagedNavDropdown.js +118 -118
- package/lib/components/Dropdowns/UserDropdown.d.ts +6 -6
- package/lib/components/Dropdowns/UserDropdown.js +76 -76
- package/lib/components/Dropdowns/index.d.ts +3 -3
- package/lib/components/Dropdowns/index.js +12 -12
- package/lib/components/EntityOwnerList.d.ts +11 -11
- package/lib/components/EntityOwnerList.js +63 -63
- package/lib/components/ErrorBoundary.d.ts +11 -11
- package/lib/components/ErrorBoundary.js +74 -74
- package/lib/components/Forms/DateField.d.ts +13 -13
- package/lib/components/Forms/DateField.js +99 -99
- package/lib/components/Forms/TimeField.d.ts +11 -11
- package/lib/components/Forms/TimeField.js +112 -112
- package/lib/components/Forms/index.d.ts +2 -2
- package/lib/components/Forms/index.js +14 -14
- package/lib/components/Groups/CreateEditCopySaveButtons.d.ts +10 -10
- package/lib/components/Groups/CreateEditCopySaveButtons.js +18 -18
- package/lib/components/Groups/GroupCreateOrEditCommonProps.d.ts +6 -6
- package/lib/components/Groups/GroupCreateOrEditCommonProps.js +2 -2
- package/lib/components/Groups/RosterSyncInfo.d.ts +5 -5
- package/lib/components/Groups/RosterSyncInfo.js +54 -54
- package/lib/components/HOC/AccessibleAppComponent.d.ts +15 -15
- package/lib/components/HOC/AccessibleAppComponent.js +135 -135
- package/lib/components/HOC/ActivityRequiredComponent.d.ts +105 -105
- package/lib/components/HOC/ActivityRequiredComponent.js +101 -101
- package/lib/components/HOC/AsyncComponent.d.ts +37 -37
- package/lib/components/HOC/AsyncComponent.js +136 -136
- package/lib/components/HOC/AuthenticatedComponent.d.ts +10 -10
- package/lib/components/HOC/AuthenticatedComponent.js +104 -104
- package/lib/components/HOC/CollectionComponent.d.ts +61 -61
- package/lib/components/HOC/CollectionComponent.js +175 -175
- package/lib/components/HOC/CollectionFirstItemComponent.d.ts +67 -67
- package/lib/components/HOC/CollectionFirstItemComponent.js +94 -94
- package/lib/components/HOC/CollectionItemComponent.d.ts +61 -61
- package/lib/components/HOC/CollectionItemComponent.js +172 -172
- package/lib/components/HOC/ConnectedModalComponent.d.ts +26 -26
- package/lib/components/HOC/ConnectedModalComponent.js +110 -110
- package/lib/components/HOC/DataDependentComponent.d.ts +61 -61
- package/lib/components/HOC/DataDependentComponent.js +90 -90
- package/lib/components/HOC/EntityComponent.d.ts +83 -83
- package/lib/components/HOC/EntityComponent.js +120 -120
- package/lib/components/HOC/FullscreenModalComponent.d.ts +74 -74
- package/lib/components/HOC/FullscreenModalComponent.js +173 -173
- package/lib/components/HOC/GroupActivityRequiredComponent.d.ts +29 -29
- package/lib/components/HOC/GroupActivityRequiredComponent.js +49 -49
- package/lib/components/HOC/GuidComponent.d.ts +14 -14
- package/lib/components/HOC/GuidComponent.js +72 -72
- package/lib/components/HOC/ModelContextDependencyVerifyComponent.d.ts +172 -172
- package/lib/components/HOC/ModelContextDependencyVerifyComponent.js +72 -72
- package/lib/components/HOC/ModelErrorRedirectComponent.d.ts +69 -69
- package/lib/components/HOC/ModelErrorRedirectComponent.js +101 -101
- package/lib/components/HOC/SearchPersistorComponent.d.ts +85 -85
- package/lib/components/HOC/SearchPersistorComponent.js +198 -198
- package/lib/components/HOC/UnauthenticatedComponent.d.ts +62 -62
- package/lib/components/HOC/UnauthenticatedComponent.js +90 -90
- package/lib/components/HOC/UserComponent.d.ts +3 -3
- package/lib/components/HOC/UserComponent.js +12 -12
- package/lib/components/Icons/IconExternalUser.d.ts +3 -3
- package/lib/components/Icons/IconExternalUser.js +24 -24
- package/lib/components/Icons/IconImpersonation.d.ts +3 -3
- package/lib/components/Icons/IconImpersonation.js +24 -24
- package/lib/components/Icons/IconStopImpersonating.d.ts +3 -3
- package/lib/components/Icons/IconStopImpersonating.js +24 -24
- package/lib/components/Impersonation/Button.d.ts +7 -7
- package/lib/components/Impersonation/Button.js +61 -61
- package/lib/components/Impersonation/Link.d.ts +7 -7
- package/lib/components/Impersonation/Link.js +58 -58
- package/lib/components/Impersonation/UserDetail.css +22 -22
- package/lib/components/Impersonation/UserDetail.d.ts +22 -22
- package/lib/components/Impersonation/UserDetail.js +23 -23
- package/lib/components/Loading.d.ts +4 -4
- package/lib/components/Loading.js +24 -24
- package/lib/components/Lti/Confirm.d.ts +8 -8
- package/lib/components/Lti/Confirm.js +37 -37
- package/lib/components/Lti/CreateNonLtiGroupAlertDialog.d.ts +15 -15
- package/lib/components/Lti/CreateNonLtiGroupAlertDialog.js +83 -83
- package/lib/components/Lti/Launch.d.ts +21 -21
- package/lib/components/Lti/Launch.js +52 -52
- package/lib/components/Lti/LaunchGroup.d.ts +9 -9
- package/lib/components/Lti/LaunchGroup.js +45 -45
- package/lib/components/NewVersionAlert.d.ts +18 -18
- package/lib/components/NewVersionAlert.js +97 -97
- package/lib/components/NotFound.d.ts +3 -3
- package/lib/components/NotFound.js +28 -28
- package/lib/components/Notifications.d.ts +39 -39
- package/lib/components/Notifications.js +175 -175
- package/lib/components/RefreshIndicator/Bordered.d.ts +7 -7
- package/lib/components/RefreshIndicator/Bordered.js +35 -35
- package/lib/components/RefreshIndicator/Inline.d.ts +4 -4
- package/lib/components/RefreshIndicator/Inline.js +36 -36
- package/lib/components/RefreshIndicator/index.d.ts +21 -21
- package/lib/components/RefreshIndicator/index.js +116 -116
- package/lib/components/SearchControls.d.ts +14 -14
- package/lib/components/SearchControls.js +34 -34
- package/lib/components/SentryRoute.d.ts +3 -3
- package/lib/components/SentryRoute.js +25 -25
- package/lib/components/Tables/RoleFilter.d.ts +14 -14
- package/lib/components/Tables/RoleFilter.js +53 -53
- package/lib/components/Tables/TextFilter.d.ts +7 -7
- package/lib/components/Tables/TextFilter.js +26 -26
- package/lib/components/UserRoles/Add.d.ts +31 -31
- package/lib/components/UserRoles/Add.js +165 -165
- package/lib/components/UserRoles/RoleCell.d.ts +21 -21
- package/lib/components/UserRoles/RoleCell.js +53 -53
- package/lib/components/UserRoles/Select.d.ts +27 -27
- package/lib/components/UserRoles/Select.js +44 -44
- package/lib/components/UserRoles/Table.d.ts +16 -16
- package/lib/components/UserRoles/Table.js +99 -99
- package/lib/components/UserRoles/index.d.ts +76 -76
- package/lib/components/UserRoles/index.js +361 -361
- package/lib/constants/baseActivity.d.ts +25 -25
- package/lib/constants/baseActivity.js +29 -29
- package/lib/constants/baseRole.d.ts +9 -9
- package/lib/constants/baseRole.js +13 -13
- package/lib/constants/configuration.d.ts +8 -8
- package/lib/constants/configuration.js +39 -39
- package/lib/constants/externalProviderType.d.ts +5 -5
- package/lib/constants/externalProviderType.js +9 -9
- package/lib/constants/index.d.ts +8 -8
- package/lib/constants/index.js +20 -20
- package/lib/constants/mockData.d.ts +82 -84
- package/lib/constants/mockData.js +379 -379
- package/lib/constants/modelStatus.d.ts +10 -10
- package/lib/constants/modelStatus.js +14 -14
- package/lib/constants/notificationType.d.ts +7 -7
- package/lib/constants/notificationType.js +11 -11
- package/lib/constants/shard.d.ts +6 -6
- package/lib/constants/shard.js +10 -10
- package/lib/constants/tier.d.ts +6 -6
- package/lib/constants/tier.js +10 -10
- package/lib/constants/userRole.d.ts +2 -2
- package/lib/constants/userRole.js +21 -21
- package/lib/css/base/_base.css +98 -98
- package/lib/css/base/_typography.css +130 -130
- package/lib/css/components/_alert.css +85 -85
- package/lib/css/components/_bootstrap-grid.css +28 -28
- package/lib/css/components/_buttons.css +325 -325
- package/lib/css/components/_forms.css +91 -91
- package/lib/css/components/_menu.css +56 -56
- package/lib/css/components/_modals.css +41 -41
- package/lib/css/components/_tables.css +426 -426
- package/lib/css/components/_tags.css +12 -12
- package/lib/css/index-with-variables.css +14 -14
- package/lib/css/index.css +13 -13
- package/lib/css/utils/_border.css +463 -463
- package/lib/css/utils/_color.css +271 -271
- package/lib/css/utils/_display.css +312 -312
- package/lib/css/utils/_general.css +48 -48
- package/lib/css/utils/_icon.css +16 -16
- package/lib/css/utils/_text.css +24 -24
- package/lib/css/utils/_width.css +60 -60
- package/lib/css/variables.css +70 -70
- package/lib/endpointMappings.d.ts +4 -4
- package/lib/endpointMappings.js +173 -173
- package/lib/hooks/useCollection.d.ts +6 -6
- package/lib/hooks/useCollection.js +61 -61
- package/lib/hooks/useCollectionConfiguration.d.ts +27 -27
- package/lib/hooks/useCollectionConfiguration.js +67 -67
- package/lib/hooks/useCollectionItem.d.ts +6 -6
- package/lib/hooks/useCollectionItem.js +54 -54
- package/lib/hooks/useGuid.d.ts +4 -4
- package/lib/hooks/useGuid.js +14 -14
- package/lib/hooks/usePrevious.d.ts +5 -5
- package/lib/hooks/usePrevious.js +18 -18
- package/lib/index.d.ts +8 -8
- package/lib/index.js +30 -30
- package/lib/redux/actionCreator.d.ts +5 -5
- package/lib/redux/actionCreator.js +16 -16
- package/lib/redux/actions.d.ts +12 -12
- package/lib/redux/actions.js +30 -30
- package/lib/redux/configureReducers.d.ts +22 -22
- package/lib/redux/configureReducers.js +94 -94
- package/lib/redux/configureStore.d.ts +14 -14
- package/lib/redux/configureStore.js +118 -118
- package/lib/redux/helpers.d.ts +2 -2
- package/lib/redux/helpers.js +7 -7
- package/lib/redux/reducers/index.d.ts +4 -4
- package/lib/redux/reducers/index.js +12 -12
- package/lib/redux/reducers/modalsReducer.d.ts +8 -8
- package/lib/redux/reducers/modalsReducer.js +54 -54
- package/lib/redux/reducers/notificationsReducer.d.ts +9 -9
- package/lib/redux/reducers/notificationsReducer.js +27 -27
- package/lib/redux/reducers/searchReducer.d.ts +17 -17
- package/lib/redux/reducers/searchReducer.js +26 -26
- package/lib/redux/sagas/caliperSaga.d.ts +2 -2
- package/lib/redux/sagas/caliperSaga.js +296 -296
- package/lib/redux/sagas/clockOffsetSaga.d.ts +10 -10
- package/lib/redux/sagas/clockOffsetSaga.js +81 -81
- package/lib/redux/sagas/configurationSaga.d.ts +1 -1
- package/lib/redux/sagas/configurationSaga.js +48 -48
- package/lib/redux/sagas/errorSaga.d.ts +2 -2
- package/lib/redux/sagas/errorSaga.js +66 -66
- package/lib/redux/sagas/identityProviderSaga.d.ts +2 -2
- package/lib/redux/sagas/identityProviderSaga.js +91 -91
- package/lib/redux/sagas/initialDataLoadSaga.d.ts +1 -1
- package/lib/redux/sagas/initialDataLoadSaga.js +33 -33
- package/lib/redux/sagas/postLoginDataSaga.d.ts +9 -9
- package/lib/redux/sagas/postLoginDataSaga.js +87 -87
- package/lib/redux/sagas/postLoginRedirectSaga.d.ts +6 -6
- package/lib/redux/sagas/postLoginRedirectSaga.js +96 -96
- package/lib/redux/sagas/rootSaga.d.ts +5 -5
- package/lib/redux/sagas/rootSaga.js +144 -144
- package/lib/redux/sagas/sentrySaga.d.ts +1 -1
- package/lib/redux/sagas/sentrySaga.js +103 -103
- package/lib/services/codeProviderService.d.ts +3 -3
- package/lib/services/codeProviderService.js +36 -36
- package/lib/services/documentService.d.ts +10 -10
- package/lib/services/documentService.js +17 -17
- package/lib/services/persistenceService.d.ts +13 -13
- package/lib/services/persistenceService.js +45 -45
- package/lib/services/ticketProviderService.d.ts +3 -3
- package/lib/services/ticketProviderService.js +40 -40
- package/lib/services/windowService.d.ts +9 -9
- package/lib/services/windowService.js +15 -15
- package/lib/setupTests.d.ts +1 -1
- package/lib/setupTests.js +25 -25
- package/lib/startup.d.ts +29 -29
- package/lib/startup.js +128 -128
- package/lib/types/AppConfiguration.d.ts +32 -32
- package/lib/types/AppConfiguration.js +2 -2
- package/lib/types/Artifact.d.ts +14 -14
- package/lib/types/Artifact.js +9 -9
- package/lib/types/BaseReduxState.d.ts +57 -57
- package/lib/types/BaseReduxState.js +2 -2
- package/lib/types/Client.d.ts +6 -6
- package/lib/types/Client.js +2 -2
- package/lib/types/Collection.d.ts +175 -175
- package/lib/types/Collection.js +2 -2
- package/lib/types/Configuration.d.ts +12 -12
- package/lib/types/Configuration.js +2 -2
- package/lib/types/DeepLinkingResponseRequest.d.ts +4 -4
- package/lib/types/DeepLinkingResponseRequest.js +2 -2
- package/lib/types/DeletableModel.d.ts +4 -4
- package/lib/types/DeletableModel.js +2 -2
- package/lib/types/External.d.ts +31 -31
- package/lib/types/External.js +2 -2
- package/lib/types/Group.d.ts +19 -19
- package/lib/types/Group.js +2 -2
- package/lib/types/IdentityProvider.d.ts +11 -11
- package/lib/types/IdentityProvider.js +2 -2
- package/lib/types/LtiLaunch.d.ts +20 -20
- package/lib/types/LtiLaunch.js +2 -2
- package/lib/types/NameOnlyEntity.d.ts +3 -3
- package/lib/types/NameOnlyEntity.js +2 -2
- package/lib/types/Notification.d.ts +15 -15
- package/lib/types/Notification.js +2 -2
- package/lib/types/OptionalRecord.d.ts +4 -4
- package/lib/types/OptionalRecord.js +2 -2
- package/lib/types/OwnerSchedule.d.ts +9 -9
- package/lib/types/OwnerSchedule.js +2 -2
- package/lib/types/PropertyOfType.d.ts +12 -12
- package/lib/types/PropertyOfType.js +2 -2
- package/lib/types/RoleDescription.d.ts +4 -4
- package/lib/types/RoleDescription.js +2 -2
- package/lib/types/Search.d.ts +11 -11
- package/lib/types/Search.js +2 -2
- package/lib/types/SimpleLocation.d.ts +46 -46
- package/lib/types/SimpleLocation.js +2 -2
- package/lib/types/UniTime.d.ts +17 -17
- package/lib/types/UniTime.js +2 -2
- package/lib/types/User.d.ts +68 -68
- package/lib/types/User.js +2 -2
- package/lib/types/UserRole.d.ts +19 -19
- package/lib/types/UserRole.js +2 -2
- package/lib/types/index.d.ts +21 -21
- package/lib/types/index.js +33 -33
- package/lib/utils/baseActivity.d.ts +63 -63
- package/lib/utils/baseActivity.js +155 -155
- package/lib/utils/baseRole.d.ts +2 -2
- package/lib/utils/baseRole.js +38 -38
- package/lib/utils/collection.d.ts +43 -43
- package/lib/utils/collection.js +337 -337
- package/lib/utils/date.d.ts +162 -162
- package/lib/utils/date.js +401 -401
- package/lib/utils/domainIdentifier.d.ts +2 -2
- package/lib/utils/domainIdentifier.js +12 -12
- package/lib/utils/entityUserRole.d.ts +3 -3
- package/lib/utils/entityUserRole.js +7 -7
- package/lib/utils/externalGroup.d.ts +4 -4
- package/lib/utils/externalGroup.js +32 -32
- package/lib/utils/externalProviders.d.ts +2 -2
- package/lib/utils/externalProviders.js +11 -11
- package/lib/utils/externalTerms.d.ts +2 -2
- package/lib/utils/externalTerms.js +10 -10
- package/lib/utils/group.d.ts +15 -15
- package/lib/utils/group.js +15 -15
- package/lib/utils/groupDates.d.ts +9 -9
- package/lib/utils/groupDates.js +52 -52
- package/lib/utils/groupRoles.d.ts +8 -8
- package/lib/utils/groupRoles.js +42 -42
- package/lib/utils/logger.d.ts +10 -10
- package/lib/utils/logger.js +34 -34
- package/lib/utils/lti.d.ts +3 -3
- package/lib/utils/lti.js +9 -9
- package/lib/utils/model.d.ts +15 -15
- package/lib/utils/model.js +58 -58
- package/lib/utils/number.d.ts +13 -13
- package/lib/utils/number.js +32 -32
- package/lib/utils/promise.d.ts +5 -5
- package/lib/utils/promise.js +17 -17
- package/lib/utils/route.d.ts +5 -5
- package/lib/utils/route.js +69 -69
- package/lib/utils/shard.d.ts +3 -3
- package/lib/utils/shard.js +45 -45
- package/lib/utils/sort.d.ts +11 -11
- package/lib/utils/sort.js +69 -69
- package/lib/utils/string.d.ts +2 -2
- package/lib/utils/string.js +16 -16
- package/lib/utils/timezone.d.ts +2 -2
- package/lib/utils/timezone.js +32 -32
- package/lib/utils/url.d.ts +23 -23
- package/lib/utils/url.js +163 -163
- package/lib/utils/user.d.ts +8 -8
- package/lib/utils/user.js +73 -73
- package/lib/utils/userRole.d.ts +21 -21
- package/lib/utils/userRole.js +48 -48
- package/package.json +192 -192
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
import TIER from '../constants/tier';
|
|
2
|
-
export interface AppConfiguration {
|
|
3
|
-
NODE_ENV: 'development' | 'production' | 'test';
|
|
4
|
-
APP_NAME: string;
|
|
5
|
-
VERSION?: string;
|
|
6
|
-
VERSION_NAME?: string;
|
|
7
|
-
TIER: TIER;
|
|
8
|
-
API_BASE_URL: string;
|
|
9
|
-
ROOT_DOMAIN: string;
|
|
10
|
-
LOCALHOST_SHARD_KEY?: string;
|
|
11
|
-
/** Custom Storage URL for local development against vm */
|
|
12
|
-
STORAGE_URL?: string;
|
|
13
|
-
CALIPER_EXTENSIONS_NAMESPACE?: string;
|
|
14
|
-
CALIPER_SENSOR_ID?: string;
|
|
15
|
-
CALIPER_SENSOR_APP_ID?: string;
|
|
16
|
-
CALIPER_SENSOR_APP_NAME?: string;
|
|
17
|
-
CALIPER_EVENT_STORE_OPTIONS?: {
|
|
18
|
-
protocol: string;
|
|
19
|
-
port: string;
|
|
20
|
-
path: string;
|
|
21
|
-
method: string;
|
|
22
|
-
};
|
|
23
|
-
GOOGLE_ANALYTICS_TRACKING_ID?: string;
|
|
24
|
-
SENTRY_DSN?: string;
|
|
25
|
-
SENTRY_TRACES_SAMPLE_RATE?: number;
|
|
26
|
-
APP_INSIGHTS_KEY?: string;
|
|
27
|
-
CLIENT_ID: string;
|
|
28
|
-
CLIENT_SECRET: string;
|
|
29
|
-
IS_DOWNTIME: boolean;
|
|
30
|
-
LMS_NAME: string;
|
|
31
|
-
GRADABLE_DESCRIPTOR: string;
|
|
32
|
-
}
|
|
1
|
+
import TIER from '../constants/tier';
|
|
2
|
+
export interface AppConfiguration {
|
|
3
|
+
NODE_ENV: 'development' | 'production' | 'test';
|
|
4
|
+
APP_NAME: string;
|
|
5
|
+
VERSION?: string;
|
|
6
|
+
VERSION_NAME?: string;
|
|
7
|
+
TIER: TIER;
|
|
8
|
+
API_BASE_URL: string;
|
|
9
|
+
ROOT_DOMAIN: string;
|
|
10
|
+
LOCALHOST_SHARD_KEY?: string;
|
|
11
|
+
/** Custom Storage URL for local development against vm */
|
|
12
|
+
STORAGE_URL?: string;
|
|
13
|
+
CALIPER_EXTENSIONS_NAMESPACE?: string;
|
|
14
|
+
CALIPER_SENSOR_ID?: string;
|
|
15
|
+
CALIPER_SENSOR_APP_ID?: string;
|
|
16
|
+
CALIPER_SENSOR_APP_NAME?: string;
|
|
17
|
+
CALIPER_EVENT_STORE_OPTIONS?: {
|
|
18
|
+
protocol: string;
|
|
19
|
+
port: string;
|
|
20
|
+
path: string;
|
|
21
|
+
method: string;
|
|
22
|
+
};
|
|
23
|
+
GOOGLE_ANALYTICS_TRACKING_ID?: string;
|
|
24
|
+
SENTRY_DSN?: string;
|
|
25
|
+
SENTRY_TRACES_SAMPLE_RATE?: number;
|
|
26
|
+
APP_INSIGHTS_KEY?: string;
|
|
27
|
+
CLIENT_ID: string;
|
|
28
|
+
CLIENT_SECRET: string;
|
|
29
|
+
IS_DOWNTIME: boolean;
|
|
30
|
+
LMS_NAME: string;
|
|
31
|
+
GRADABLE_DESCRIPTOR: string;
|
|
32
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/lib/types/Artifact.d.ts
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import { Model } from 'studiokit-net-js';
|
|
2
|
-
export declare enum ARTIFACT_TYPE {
|
|
3
|
-
TEXT_ARTIFACT = "TextArtifact",
|
|
4
|
-
FILE_ARTIFACT = "FileArtifact",
|
|
5
|
-
URL_ARTIFACT = "UrlArtifact"
|
|
6
|
-
}
|
|
7
|
-
export interface Artifact extends Model {
|
|
8
|
-
url: string;
|
|
9
|
-
fileName: string;
|
|
10
|
-
wordCount: number | null;
|
|
11
|
-
typename: ARTIFACT_TYPE;
|
|
12
|
-
dateStored: string;
|
|
13
|
-
dateLastUpdated: string;
|
|
14
|
-
}
|
|
1
|
+
import { Model } from 'studiokit-net-js';
|
|
2
|
+
export declare enum ARTIFACT_TYPE {
|
|
3
|
+
TEXT_ARTIFACT = "TextArtifact",
|
|
4
|
+
FILE_ARTIFACT = "FileArtifact",
|
|
5
|
+
URL_ARTIFACT = "UrlArtifact"
|
|
6
|
+
}
|
|
7
|
+
export interface Artifact extends Model {
|
|
8
|
+
url: string;
|
|
9
|
+
fileName: string;
|
|
10
|
+
wordCount: number | null;
|
|
11
|
+
typename: ARTIFACT_TYPE;
|
|
12
|
+
dateStored: string;
|
|
13
|
+
dateLastUpdated: string;
|
|
14
|
+
}
|
package/lib/types/Artifact.js
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ARTIFACT_TYPE = void 0;
|
|
4
|
-
var ARTIFACT_TYPE;
|
|
5
|
-
(function (ARTIFACT_TYPE) {
|
|
6
|
-
ARTIFACT_TYPE["TEXT_ARTIFACT"] = "TextArtifact";
|
|
7
|
-
ARTIFACT_TYPE["FILE_ARTIFACT"] = "FileArtifact";
|
|
8
|
-
ARTIFACT_TYPE["URL_ARTIFACT"] = "UrlArtifact";
|
|
9
|
-
})(ARTIFACT_TYPE = exports.ARTIFACT_TYPE || (exports.ARTIFACT_TYPE = {}));
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ARTIFACT_TYPE = void 0;
|
|
4
|
+
var ARTIFACT_TYPE;
|
|
5
|
+
(function (ARTIFACT_TYPE) {
|
|
6
|
+
ARTIFACT_TYPE["TEXT_ARTIFACT"] = "TextArtifact";
|
|
7
|
+
ARTIFACT_TYPE["FILE_ARTIFACT"] = "FileArtifact";
|
|
8
|
+
ARTIFACT_TYPE["URL_ARTIFACT"] = "UrlArtifact";
|
|
9
|
+
})(ARTIFACT_TYPE = exports.ARTIFACT_TYPE || (exports.ARTIFACT_TYPE = {}));
|
|
@@ -1,57 +1,57 @@
|
|
|
1
|
-
import { RouterState } from 'connected-react-router';
|
|
2
|
-
import { PersistedState } from 'redux-persist';
|
|
3
|
-
import { AuthState } from 'studiokit-auth-js';
|
|
4
|
-
import { ModelCollection, ModelsState } from 'studiokit-net-js';
|
|
5
|
-
import { ModalsState } from '../redux/reducers/modalsReducer';
|
|
6
|
-
import { NotificationState } from '../redux/reducers/notificationsReducer';
|
|
7
|
-
import { SearchState } from '../redux/reducers/searchReducer';
|
|
8
|
-
import { Client } from './Client';
|
|
9
|
-
import { Configuration } from './Configuration';
|
|
10
|
-
import { ExternalProvider, ExternalTerm } from './External';
|
|
11
|
-
import { Group } from './Group';
|
|
12
|
-
import { IdentityProvider } from './IdentityProvider';
|
|
13
|
-
import { LtiLaunch } from './LtiLaunch';
|
|
14
|
-
import { User, UserInfo } from './User';
|
|
15
|
-
import { UserWithRoles } from './UserRole';
|
|
16
|
-
/**
|
|
17
|
-
* Extends the base object in redux at `state.models`, with all scaffolding related collections and models.
|
|
18
|
-
*
|
|
19
|
-
* @template TGroup The type of group stored in `state.models.group`. Defaults to `Group`.
|
|
20
|
-
* @template TSearch The type of search model stored in `state.models.search`
|
|
21
|
-
*/
|
|
22
|
-
export interface BaseModelsState<TGroup extends Group = Group, TSearch extends BaseSearchModelsState<TGroup> = BaseSearchModelsState<TGroup>> extends ModelsState {
|
|
23
|
-
configuration?: Configuration;
|
|
24
|
-
client?: Client;
|
|
25
|
-
identityProviders?: ModelCollection<IdentityProvider>;
|
|
26
|
-
externalTerms?: ModelCollection<ExternalTerm>;
|
|
27
|
-
externalProviders?: ModelCollection<ExternalProvider>;
|
|
28
|
-
groups?: ModelCollection<TGroup>;
|
|
29
|
-
userRoles?: ModelCollection<UserWithRoles>;
|
|
30
|
-
ltiLaunches?: ModelCollection<LtiLaunch>;
|
|
31
|
-
search?: TSearch;
|
|
32
|
-
user?: {
|
|
33
|
-
userInfo?: UserInfo;
|
|
34
|
-
};
|
|
35
|
-
}
|
|
36
|
-
/**
|
|
37
|
-
* Extends the base object in redux at `state.models.search`, with all scaffolding related collections and models.
|
|
38
|
-
*
|
|
39
|
-
* @template TGroup The type of group stored in `state.models.search.group`. Defaults to `Group`.
|
|
40
|
-
*/
|
|
41
|
-
export interface BaseSearchModelsState<TGroup extends Group = Group> extends ModelsState {
|
|
42
|
-
users?: ModelCollection<User>;
|
|
43
|
-
groups?: ModelCollection<TGroup>;
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* Defines the base redux state of the application.
|
|
47
|
-
*
|
|
48
|
-
* @template TModels The type of state to be stored at `state.models`, allowing for extension.
|
|
49
|
-
*/
|
|
50
|
-
export interface BaseReduxState<TModels extends BaseModelsState = BaseModelsState> {
|
|
51
|
-
auth: AuthState & PersistedState;
|
|
52
|
-
notifications: NotificationState & PersistedState;
|
|
53
|
-
modals: ModalsState;
|
|
54
|
-
models: TModels;
|
|
55
|
-
router: RouterState;
|
|
56
|
-
search: SearchState;
|
|
57
|
-
}
|
|
1
|
+
import { RouterState } from 'connected-react-router';
|
|
2
|
+
import { PersistedState } from 'redux-persist';
|
|
3
|
+
import { AuthState } from 'studiokit-auth-js';
|
|
4
|
+
import { ModelCollection, ModelsState } from 'studiokit-net-js';
|
|
5
|
+
import { ModalsState } from '../redux/reducers/modalsReducer';
|
|
6
|
+
import { NotificationState } from '../redux/reducers/notificationsReducer';
|
|
7
|
+
import { SearchState } from '../redux/reducers/searchReducer';
|
|
8
|
+
import { Client } from './Client';
|
|
9
|
+
import { Configuration } from './Configuration';
|
|
10
|
+
import { ExternalProvider, ExternalTerm } from './External';
|
|
11
|
+
import { Group } from './Group';
|
|
12
|
+
import { IdentityProvider } from './IdentityProvider';
|
|
13
|
+
import { LtiLaunch } from './LtiLaunch';
|
|
14
|
+
import { User, UserInfo } from './User';
|
|
15
|
+
import { UserWithRoles } from './UserRole';
|
|
16
|
+
/**
|
|
17
|
+
* Extends the base object in redux at `state.models`, with all scaffolding related collections and models.
|
|
18
|
+
*
|
|
19
|
+
* @template TGroup The type of group stored in `state.models.group`. Defaults to `Group`.
|
|
20
|
+
* @template TSearch The type of search model stored in `state.models.search`
|
|
21
|
+
*/
|
|
22
|
+
export interface BaseModelsState<TGroup extends Group = Group, TSearch extends BaseSearchModelsState<TGroup> = BaseSearchModelsState<TGroup>> extends ModelsState {
|
|
23
|
+
configuration?: Configuration;
|
|
24
|
+
client?: Client;
|
|
25
|
+
identityProviders?: ModelCollection<IdentityProvider>;
|
|
26
|
+
externalTerms?: ModelCollection<ExternalTerm>;
|
|
27
|
+
externalProviders?: ModelCollection<ExternalProvider>;
|
|
28
|
+
groups?: ModelCollection<TGroup>;
|
|
29
|
+
userRoles?: ModelCollection<UserWithRoles>;
|
|
30
|
+
ltiLaunches?: ModelCollection<LtiLaunch>;
|
|
31
|
+
search?: TSearch;
|
|
32
|
+
user?: {
|
|
33
|
+
userInfo?: UserInfo;
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Extends the base object in redux at `state.models.search`, with all scaffolding related collections and models.
|
|
38
|
+
*
|
|
39
|
+
* @template TGroup The type of group stored in `state.models.search.group`. Defaults to `Group`.
|
|
40
|
+
*/
|
|
41
|
+
export interface BaseSearchModelsState<TGroup extends Group = Group> extends ModelsState {
|
|
42
|
+
users?: ModelCollection<User>;
|
|
43
|
+
groups?: ModelCollection<TGroup>;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Defines the base redux state of the application.
|
|
47
|
+
*
|
|
48
|
+
* @template TModels The type of state to be stored at `state.models`, allowing for extension.
|
|
49
|
+
*/
|
|
50
|
+
export interface BaseReduxState<TModels extends BaseModelsState = BaseModelsState> {
|
|
51
|
+
auth: AuthState & PersistedState;
|
|
52
|
+
notifications: NotificationState & PersistedState;
|
|
53
|
+
modals: ModalsState;
|
|
54
|
+
models: TModels;
|
|
55
|
+
router: RouterState;
|
|
56
|
+
search: SearchState;
|
|
57
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/lib/types/Client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Model } from 'studiokit-net-js';
|
|
2
|
-
export interface Client extends Model {
|
|
3
|
-
clientId: string;
|
|
4
|
-
currentVersion?: string;
|
|
5
|
-
minVersion?: string;
|
|
6
|
-
}
|
|
1
|
+
import { Model } from 'studiokit-net-js';
|
|
2
|
+
export interface Client extends Model {
|
|
3
|
+
clientId: string;
|
|
4
|
+
currentVersion?: string;
|
|
5
|
+
minVersion?: string;
|
|
6
|
+
}
|
package/lib/types/Client.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -1,175 +1,175 @@
|
|
|
1
|
-
import { Dictionary } from 'lodash';
|
|
2
|
-
import { Model, ModelCollection } from 'studiokit-net-js';
|
|
3
|
-
import { MODEL_STATUS } from '..';
|
|
4
|
-
import { BaseReduxState } from '.';
|
|
5
|
-
/** The props shared by collection HOCs and hooks. */
|
|
6
|
-
export interface CollectionCommonProps {
|
|
7
|
-
/**
|
|
8
|
-
* The generic path (no Ids) to where the model is stored in redux.
|
|
9
|
-
* A path relating to an item in defined in `constants/configuration/getEndpointMappings()` (levels separated by a '.').
|
|
10
|
-
* Can be set in constructor or at render time, e.g. `<C modelName="otherModel" />`
|
|
11
|
-
*/
|
|
12
|
-
modelName: string;
|
|
13
|
-
/** The Ids that will be inserted between the components of `modelName`, to link to specific collection items in redux. */
|
|
14
|
-
pathParams: string[];
|
|
15
|
-
/** Custom queryParams for use in all requests. */
|
|
16
|
-
queryParams?: Dictionary<string>;
|
|
17
|
-
/** Whether or not to trigger `load()` after mounting. Default is `false`. */
|
|
18
|
-
disableAutoLoad?: boolean;
|
|
19
|
-
}
|
|
20
|
-
/** See `CollectionSelectorMethod` */
|
|
21
|
-
export interface CollectionSelectorMethodParams {
|
|
22
|
-
guid: string;
|
|
23
|
-
modelName: string;
|
|
24
|
-
pathParams: string[];
|
|
25
|
-
routeMatchParams: Dictionary<any>;
|
|
26
|
-
state: BaseReduxState;
|
|
27
|
-
}
|
|
28
|
-
/** See `CollectionSelectorMethod` */
|
|
29
|
-
export interface CollectionSelectorMethodResponse<TModel extends Model> {
|
|
30
|
-
modelName: string;
|
|
31
|
-
pathParams: string[];
|
|
32
|
-
model: TModel | ModelCollection<TModel>;
|
|
33
|
-
modelArray?: TModel[];
|
|
34
|
-
modelMinusRelations?: Partial<TModel>;
|
|
35
|
-
}
|
|
36
|
-
/** A method used to select a collection or collection item model from redux. */
|
|
37
|
-
export declare type CollectionSelectorMethod = <TModel extends Model>(params: CollectionSelectorMethodParams) => CollectionSelectorMethodResponse<TModel>;
|
|
38
|
-
/** The configuration object passed to all collection methods,
|
|
39
|
-
* to encapsulate logic and state from the calling collection HOC or hook. */
|
|
40
|
-
export interface CollectionMethodConfiguration extends CollectionCommonProps {
|
|
41
|
-
guid: string;
|
|
42
|
-
modelStatus: MODEL_STATUS;
|
|
43
|
-
changeModelStatus: (modelStatus: MODEL_STATUS, fetchingId?: string) => void;
|
|
44
|
-
}
|
|
45
|
-
export interface CollectionItemLoadParams {
|
|
46
|
-
/** Custom pathParams for use in the request. */
|
|
47
|
-
pathParams?: string[];
|
|
48
|
-
/** Custom queryParams for use in the request. */
|
|
49
|
-
queryParams?: Dictionary<string>;
|
|
50
|
-
/** The period (in ms) at which the collection should reload the data. */
|
|
51
|
-
period?: number;
|
|
52
|
-
/** The taskId to set for later cancellation. */
|
|
53
|
-
taskId?: string;
|
|
54
|
-
}
|
|
55
|
-
export interface CollectionLoadParams {
|
|
56
|
-
/** Id of an item in the collection to load. Otherwise entire collection is loaded. */
|
|
57
|
-
id?: string;
|
|
58
|
-
/** Custom pathParams for use in the request. */
|
|
59
|
-
pathParams?: string[];
|
|
60
|
-
/** Custom queryParams for use in the request. */
|
|
61
|
-
queryParams?: Dictionary<string>;
|
|
62
|
-
/** The period (in ms) at which the collection should reload the data. */
|
|
63
|
-
period?: number;
|
|
64
|
-
/** The taskId to set for later cancellation. */
|
|
65
|
-
taskId?: string;
|
|
66
|
-
}
|
|
67
|
-
export interface CollectionCreateParams {
|
|
68
|
-
/** The body to send in the request. */
|
|
69
|
-
body: any;
|
|
70
|
-
/** The 'Content-Type' header value to use. */
|
|
71
|
-
contentType?: string;
|
|
72
|
-
/** Custom queryParams for use in the request. */
|
|
73
|
-
queryParams?: Dictionary<string>;
|
|
74
|
-
}
|
|
75
|
-
export interface CollectionUpdateParams {
|
|
76
|
-
/** The id of the collection item to update. */
|
|
77
|
-
id: string;
|
|
78
|
-
/** The body to send in the request. */
|
|
79
|
-
body: any;
|
|
80
|
-
/** The 'Content-Type' header value to use. */
|
|
81
|
-
contentType?: string;
|
|
82
|
-
/** The HTTP method to use. Defaults to 'PUT'. */
|
|
83
|
-
method?: string;
|
|
84
|
-
/** Custom queryParams for use in the request. */
|
|
85
|
-
queryParams?: Dictionary<string>;
|
|
86
|
-
}
|
|
87
|
-
export interface CollectionItemUpdateParams {
|
|
88
|
-
/** The body to send in the request. */
|
|
89
|
-
body: any;
|
|
90
|
-
/** The 'Content-Type' header value to use. */
|
|
91
|
-
contentType?: string;
|
|
92
|
-
/** The HTTP method to use. Defaults to 'PUT'. */
|
|
93
|
-
method?: string;
|
|
94
|
-
/** Custom queryParams for use in the request. */
|
|
95
|
-
queryParams?: Dictionary<string>;
|
|
96
|
-
}
|
|
97
|
-
export interface CollectionDeleteParams {
|
|
98
|
-
/** The id of the collection item to delete. */
|
|
99
|
-
id: string;
|
|
100
|
-
/** The body to send in the request. */
|
|
101
|
-
body?: any;
|
|
102
|
-
/** Custom queryParams for use in the request. */
|
|
103
|
-
queryParams?: Dictionary<string>;
|
|
104
|
-
}
|
|
105
|
-
export interface CollectionItemDeleteParams {
|
|
106
|
-
/** The body to send in the request. */
|
|
107
|
-
body?: any;
|
|
108
|
-
/** Custom queryParams for use in the request. */
|
|
109
|
-
queryParams?: Dictionary<string>;
|
|
110
|
-
}
|
|
111
|
-
/** The methods returned by `CollectionItemComponent` or `useCollectionItem`. */
|
|
112
|
-
export interface CollectionItemMethods {
|
|
113
|
-
/** Dispatch a GET request for the collection item. */
|
|
114
|
-
load: (params?: CollectionItemLoadParams) => void;
|
|
115
|
-
/**
|
|
116
|
-
* Stop periodic fetch of the collection.
|
|
117
|
-
*
|
|
118
|
-
* @param taskId The taskId that was initially set when periodic fetch was requested.
|
|
119
|
-
*/
|
|
120
|
-
stopPeriodicLoad: (taskId: string) => void;
|
|
121
|
-
/**
|
|
122
|
-
* Dispatch a POST request to create the collection item.
|
|
123
|
-
*
|
|
124
|
-
* The new item can be tracked using the `guid` as its key in the parent collection.
|
|
125
|
-
*/
|
|
126
|
-
create: (params: CollectionCreateParams) => void;
|
|
127
|
-
/** Dispatch a PUT request to update the collection item. */
|
|
128
|
-
update: (params: CollectionItemUpdateParams) => void;
|
|
129
|
-
/** Dispatch a DELETE request to remove the collection item. */
|
|
130
|
-
delete: (params?: CollectionItemDeleteParams) => void;
|
|
131
|
-
}
|
|
132
|
-
/** The methods returned by `CollectionComponent` or `useCollection`. */
|
|
133
|
-
export interface CollectionMethods {
|
|
134
|
-
/** Dispatch a GET request for the collection, or an item in the collection. */
|
|
135
|
-
load: (params?: CollectionLoadParams) => void;
|
|
136
|
-
/**
|
|
137
|
-
* Stop periodic fetch of the collection.
|
|
138
|
-
*
|
|
139
|
-
* @param taskId The taskId that was initially set when periodic fetch was requested.
|
|
140
|
-
*/
|
|
141
|
-
stopPeriodicLoad: (taskId: string) => void;
|
|
142
|
-
/**
|
|
143
|
-
* Dispatch a POST request to create an item in the collection.
|
|
144
|
-
*
|
|
145
|
-
* The new item can be tracked using the `guid` at `model[guid]`.
|
|
146
|
-
*/
|
|
147
|
-
create: (params: CollectionCreateParams) => void;
|
|
148
|
-
/** Dispatch a PUT request to update an item in the collection. */
|
|
149
|
-
update: (params: CollectionUpdateParams) => void;
|
|
150
|
-
/** Dispatch a DELETE request to remove an item from the collection. */
|
|
151
|
-
delete: (params: CollectionDeleteParams) => void;
|
|
152
|
-
}
|
|
153
|
-
/** The response from selecting a collection item model from redux. */
|
|
154
|
-
export interface CollectionItemReduxResponse<TModel extends Model> {
|
|
155
|
-
/** The collection item model loaded from redux, or loaded into redux using `load()`. */
|
|
156
|
-
model: TModel;
|
|
157
|
-
/** The collection item model, without any of its nested relations. */
|
|
158
|
-
modelMinusRelations: Partial<TModel>;
|
|
159
|
-
}
|
|
160
|
-
/** The response from selecting a collection model from redux. */
|
|
161
|
-
export interface CollectionReduxResponse<TModel extends Model> {
|
|
162
|
-
/** The collection model loaded from redux if available, or loaded into redux using `load()`. */
|
|
163
|
-
model: ModelCollection<TModel>;
|
|
164
|
-
/** The collection model converted to an array of all collection items. */
|
|
165
|
-
modelArray: TModel[];
|
|
166
|
-
}
|
|
167
|
-
/** The internal state shared by collection HOCs and hooks. */
|
|
168
|
-
export interface CollectionCommonState {
|
|
169
|
-
/** The current status of the model. */
|
|
170
|
-
modelStatus: MODEL_STATUS;
|
|
171
|
-
/** The previous status of the model. */
|
|
172
|
-
previousModelStatus: MODEL_STATUS;
|
|
173
|
-
/** An id that is used when targeting a specific item in a collection. Only applies when `model` is a collection. */
|
|
174
|
-
fetchingId?: string;
|
|
175
|
-
}
|
|
1
|
+
import { Dictionary } from 'lodash';
|
|
2
|
+
import { Model, ModelCollection } from 'studiokit-net-js';
|
|
3
|
+
import { MODEL_STATUS } from '..';
|
|
4
|
+
import { BaseReduxState } from '.';
|
|
5
|
+
/** The props shared by collection HOCs and hooks. */
|
|
6
|
+
export interface CollectionCommonProps {
|
|
7
|
+
/**
|
|
8
|
+
* The generic path (no Ids) to where the model is stored in redux.
|
|
9
|
+
* A path relating to an item in defined in `constants/configuration/getEndpointMappings()` (levels separated by a '.').
|
|
10
|
+
* Can be set in constructor or at render time, e.g. `<C modelName="otherModel" />`
|
|
11
|
+
*/
|
|
12
|
+
modelName: string;
|
|
13
|
+
/** The Ids that will be inserted between the components of `modelName`, to link to specific collection items in redux. */
|
|
14
|
+
pathParams: string[];
|
|
15
|
+
/** Custom queryParams for use in all requests. */
|
|
16
|
+
queryParams?: Dictionary<string>;
|
|
17
|
+
/** Whether or not to trigger `load()` after mounting. Default is `false`. */
|
|
18
|
+
disableAutoLoad?: boolean;
|
|
19
|
+
}
|
|
20
|
+
/** See `CollectionSelectorMethod` */
|
|
21
|
+
export interface CollectionSelectorMethodParams {
|
|
22
|
+
guid: string;
|
|
23
|
+
modelName: string;
|
|
24
|
+
pathParams: string[];
|
|
25
|
+
routeMatchParams: Dictionary<any>;
|
|
26
|
+
state: BaseReduxState;
|
|
27
|
+
}
|
|
28
|
+
/** See `CollectionSelectorMethod` */
|
|
29
|
+
export interface CollectionSelectorMethodResponse<TModel extends Model> {
|
|
30
|
+
modelName: string;
|
|
31
|
+
pathParams: string[];
|
|
32
|
+
model: TModel | ModelCollection<TModel>;
|
|
33
|
+
modelArray?: TModel[];
|
|
34
|
+
modelMinusRelations?: Partial<TModel>;
|
|
35
|
+
}
|
|
36
|
+
/** A method used to select a collection or collection item model from redux. */
|
|
37
|
+
export declare type CollectionSelectorMethod = <TModel extends Model>(params: CollectionSelectorMethodParams) => CollectionSelectorMethodResponse<TModel>;
|
|
38
|
+
/** The configuration object passed to all collection methods,
|
|
39
|
+
* to encapsulate logic and state from the calling collection HOC or hook. */
|
|
40
|
+
export interface CollectionMethodConfiguration extends CollectionCommonProps {
|
|
41
|
+
guid: string;
|
|
42
|
+
modelStatus: MODEL_STATUS;
|
|
43
|
+
changeModelStatus: (modelStatus: MODEL_STATUS, fetchingId?: string) => void;
|
|
44
|
+
}
|
|
45
|
+
export interface CollectionItemLoadParams {
|
|
46
|
+
/** Custom pathParams for use in the request. */
|
|
47
|
+
pathParams?: string[];
|
|
48
|
+
/** Custom queryParams for use in the request. */
|
|
49
|
+
queryParams?: Dictionary<string>;
|
|
50
|
+
/** The period (in ms) at which the collection should reload the data. */
|
|
51
|
+
period?: number;
|
|
52
|
+
/** The taskId to set for later cancellation. */
|
|
53
|
+
taskId?: string;
|
|
54
|
+
}
|
|
55
|
+
export interface CollectionLoadParams {
|
|
56
|
+
/** Id of an item in the collection to load. Otherwise entire collection is loaded. */
|
|
57
|
+
id?: string;
|
|
58
|
+
/** Custom pathParams for use in the request. */
|
|
59
|
+
pathParams?: string[];
|
|
60
|
+
/** Custom queryParams for use in the request. */
|
|
61
|
+
queryParams?: Dictionary<string>;
|
|
62
|
+
/** The period (in ms) at which the collection should reload the data. */
|
|
63
|
+
period?: number;
|
|
64
|
+
/** The taskId to set for later cancellation. */
|
|
65
|
+
taskId?: string;
|
|
66
|
+
}
|
|
67
|
+
export interface CollectionCreateParams {
|
|
68
|
+
/** The body to send in the request. */
|
|
69
|
+
body: any;
|
|
70
|
+
/** The 'Content-Type' header value to use. */
|
|
71
|
+
contentType?: string;
|
|
72
|
+
/** Custom queryParams for use in the request. */
|
|
73
|
+
queryParams?: Dictionary<string>;
|
|
74
|
+
}
|
|
75
|
+
export interface CollectionUpdateParams {
|
|
76
|
+
/** The id of the collection item to update. */
|
|
77
|
+
id: string;
|
|
78
|
+
/** The body to send in the request. */
|
|
79
|
+
body: any;
|
|
80
|
+
/** The 'Content-Type' header value to use. */
|
|
81
|
+
contentType?: string;
|
|
82
|
+
/** The HTTP method to use. Defaults to 'PUT'. */
|
|
83
|
+
method?: string;
|
|
84
|
+
/** Custom queryParams for use in the request. */
|
|
85
|
+
queryParams?: Dictionary<string>;
|
|
86
|
+
}
|
|
87
|
+
export interface CollectionItemUpdateParams {
|
|
88
|
+
/** The body to send in the request. */
|
|
89
|
+
body: any;
|
|
90
|
+
/** The 'Content-Type' header value to use. */
|
|
91
|
+
contentType?: string;
|
|
92
|
+
/** The HTTP method to use. Defaults to 'PUT'. */
|
|
93
|
+
method?: string;
|
|
94
|
+
/** Custom queryParams for use in the request. */
|
|
95
|
+
queryParams?: Dictionary<string>;
|
|
96
|
+
}
|
|
97
|
+
export interface CollectionDeleteParams {
|
|
98
|
+
/** The id of the collection item to delete. */
|
|
99
|
+
id: string;
|
|
100
|
+
/** The body to send in the request. */
|
|
101
|
+
body?: any;
|
|
102
|
+
/** Custom queryParams for use in the request. */
|
|
103
|
+
queryParams?: Dictionary<string>;
|
|
104
|
+
}
|
|
105
|
+
export interface CollectionItemDeleteParams {
|
|
106
|
+
/** The body to send in the request. */
|
|
107
|
+
body?: any;
|
|
108
|
+
/** Custom queryParams for use in the request. */
|
|
109
|
+
queryParams?: Dictionary<string>;
|
|
110
|
+
}
|
|
111
|
+
/** The methods returned by `CollectionItemComponent` or `useCollectionItem`. */
|
|
112
|
+
export interface CollectionItemMethods {
|
|
113
|
+
/** Dispatch a GET request for the collection item. */
|
|
114
|
+
load: (params?: CollectionItemLoadParams) => void;
|
|
115
|
+
/**
|
|
116
|
+
* Stop periodic fetch of the collection.
|
|
117
|
+
*
|
|
118
|
+
* @param taskId The taskId that was initially set when periodic fetch was requested.
|
|
119
|
+
*/
|
|
120
|
+
stopPeriodicLoad: (taskId: string) => void;
|
|
121
|
+
/**
|
|
122
|
+
* Dispatch a POST request to create the collection item.
|
|
123
|
+
*
|
|
124
|
+
* The new item can be tracked using the `guid` as its key in the parent collection.
|
|
125
|
+
*/
|
|
126
|
+
create: (params: CollectionCreateParams) => void;
|
|
127
|
+
/** Dispatch a PUT request to update the collection item. */
|
|
128
|
+
update: (params: CollectionItemUpdateParams) => void;
|
|
129
|
+
/** Dispatch a DELETE request to remove the collection item. */
|
|
130
|
+
delete: (params?: CollectionItemDeleteParams) => void;
|
|
131
|
+
}
|
|
132
|
+
/** The methods returned by `CollectionComponent` or `useCollection`. */
|
|
133
|
+
export interface CollectionMethods {
|
|
134
|
+
/** Dispatch a GET request for the collection, or an item in the collection. */
|
|
135
|
+
load: (params?: CollectionLoadParams) => void;
|
|
136
|
+
/**
|
|
137
|
+
* Stop periodic fetch of the collection.
|
|
138
|
+
*
|
|
139
|
+
* @param taskId The taskId that was initially set when periodic fetch was requested.
|
|
140
|
+
*/
|
|
141
|
+
stopPeriodicLoad: (taskId: string) => void;
|
|
142
|
+
/**
|
|
143
|
+
* Dispatch a POST request to create an item in the collection.
|
|
144
|
+
*
|
|
145
|
+
* The new item can be tracked using the `guid` at `model[guid]`.
|
|
146
|
+
*/
|
|
147
|
+
create: (params: CollectionCreateParams) => void;
|
|
148
|
+
/** Dispatch a PUT request to update an item in the collection. */
|
|
149
|
+
update: (params: CollectionUpdateParams) => void;
|
|
150
|
+
/** Dispatch a DELETE request to remove an item from the collection. */
|
|
151
|
+
delete: (params: CollectionDeleteParams) => void;
|
|
152
|
+
}
|
|
153
|
+
/** The response from selecting a collection item model from redux. */
|
|
154
|
+
export interface CollectionItemReduxResponse<TModel extends Model> {
|
|
155
|
+
/** The collection item model loaded from redux, or loaded into redux using `load()`. */
|
|
156
|
+
model: TModel;
|
|
157
|
+
/** The collection item model, without any of its nested relations. */
|
|
158
|
+
modelMinusRelations: Partial<TModel>;
|
|
159
|
+
}
|
|
160
|
+
/** The response from selecting a collection model from redux. */
|
|
161
|
+
export interface CollectionReduxResponse<TModel extends Model> {
|
|
162
|
+
/** The collection model loaded from redux if available, or loaded into redux using `load()`. */
|
|
163
|
+
model: ModelCollection<TModel>;
|
|
164
|
+
/** The collection model converted to an array of all collection items. */
|
|
165
|
+
modelArray: TModel[];
|
|
166
|
+
}
|
|
167
|
+
/** The internal state shared by collection HOCs and hooks. */
|
|
168
|
+
export interface CollectionCommonState {
|
|
169
|
+
/** The current status of the model. */
|
|
170
|
+
modelStatus: MODEL_STATUS;
|
|
171
|
+
/** The previous status of the model. */
|
|
172
|
+
previousModelStatus: MODEL_STATUS;
|
|
173
|
+
/** An id that is used when targeting a specific item in a collection. Only applies when `model` is a collection. */
|
|
174
|
+
fetchingId?: string;
|
|
175
|
+
}
|
package/lib/types/Collection.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import { Model } from 'studiokit-net-js';
|
|
2
|
-
export interface Configuration extends Model {
|
|
3
|
-
id: number;
|
|
4
|
-
name: string;
|
|
5
|
-
userSupportEmail: string;
|
|
6
|
-
allowedDomains: string;
|
|
7
|
-
caliperEnabled: boolean;
|
|
8
|
-
caliperEventStoreHostname?: string;
|
|
9
|
-
caliperPersonNamespace?: string;
|
|
10
|
-
defaultTimeZoneId?: string;
|
|
11
|
-
isInstructorSandboxEnabled: boolean;
|
|
12
|
-
}
|
|
1
|
+
import { Model } from 'studiokit-net-js';
|
|
2
|
+
export interface Configuration extends Model {
|
|
3
|
+
id: number;
|
|
4
|
+
name: string;
|
|
5
|
+
userSupportEmail: string;
|
|
6
|
+
allowedDomains: string;
|
|
7
|
+
caliperEnabled: boolean;
|
|
8
|
+
caliperEventStoreHostname?: string;
|
|
9
|
+
caliperPersonNamespace?: string;
|
|
10
|
+
defaultTimeZoneId?: string;
|
|
11
|
+
isInstructorSandboxEnabled: boolean;
|
|
12
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|