@c-rex/types 0.3.0-build.27710 → 0.3.0-build.28277

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 (4) hide show
  1. package/dist/index.d.mts +14 -2
  2. package/dist/index.d.ts +14 -2
  3. package/dist/index.js.map +1 -1
  4. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as Constants from '@c-rex/constants';
2
- import { DEVICE_OPTIONS, FILES_EXTENSIONS, LOG_CATEGORIES, ALL, LOG_LEVELS, OPERATOR_OPTIONS, PERSONALIZATION_MODES, RESULT_TYPES, RESULT_VIEW_STYLES, TOKEN_SOURCES, WILD_CARD_OPTIONS, ARTICLE_PAGE_LAYOUT } from '@c-rex/constants';
2
+ import { DEVICE_OPTIONS, FILES_EXTENSIONS, LOG_CATEGORIES, ALL, LOG_LEVELS, OPERATOR_OPTIONS, PERSONALIZATION_MODES, PREVIEW_UNAVAILABLE_REASONS, RESULT_TYPES, RESULT_VIEW_STYLES, TOKEN_SOURCES, WILD_CARD_OPTIONS, ARTICLE_PAGE_LAYOUT } from '@c-rex/constants';
3
3
 
4
4
  /**
5
5
  * Auto-generated from OpenAPI spec
@@ -101,6 +101,18 @@ type WildCardType = keyof typeof WILD_CARD_OPTIONS;
101
101
  type OperatorType = keyof typeof OPERATOR_OPTIONS;
102
102
  type TokenSource = (typeof TOKEN_SOURCES)[keyof typeof TOKEN_SOURCES];
103
103
  type PersonalizationMode = (typeof PERSONALIZATION_MODES)[keyof typeof PERSONALIZATION_MODES];
104
+ type PreviewUnavailableReason = (typeof PREVIEW_UNAVAILABLE_REASONS)[keyof typeof PREVIEW_UNAVAILABLE_REASONS];
105
+ /** Preview of a search result, as `/api/topics/{id}/preview` returns it. */
106
+ type TopicPreview = {
107
+ available: true;
108
+ title: string;
109
+ /** Sanitized HTML of the topic's own rendition, shown as it is (nothing is loaded into it). */
110
+ html: string;
111
+ } | {
112
+ available: false;
113
+ title: string;
114
+ reason: PreviewUnavailableReason;
115
+ };
104
116
  type FileRenditionType = {
105
117
  format: string;
106
118
  link: string;
@@ -132,4 +144,4 @@ type WarningVars = {
132
144
  default: any;
133
145
  };
134
146
 
135
- export type { AdministrativeMetadataModelField, AuditStateModelField, AuthStateModelField, CategoryModelField, ComponentModelField, ContentLifeCycleStatusModelField, ContentLifeCycleStatusValueModelField, DeviceType, DirectoryNodeModelField, DirectoryNodeTypeModelField, DocumentModelField, DocumentTypeModelField, DocumentationMetadataModelField, DocumentsType, DomainEntityModelField, EventModelField, ExternalProductGraphicModelField, ExternalProductOntologyModelField, Favorite, FileRenditionType, FilesExtensions, FragmentModelField, FunctionalMetadataModelField, IdentityDomainModelField, IdentityModelField, InformationObjectModelField, InformationSubjectCollectionModelField, InformationSubjectConformityModelField, InformationSubjectFormalityModelField, InformationSubjectFunctionalityModelField, InformationSubjectModelField, InformationSubjectProcessModelField, InformationSubjectSafetyModelField, InformationSubjectSafetyWarningMessageModelField, InformationSubjectTechnicalDataModelField, InformationSubjectTechnicalOverviewModelField, InformationTypeModelField, InformationUnitModelField, LogCategoriesType, LogLevelType, OperatorType, OwlClassModelField, PackageModelField, PartyModelField, PartyRoleModelField, PersonalizationMode, PlanningDownTimeModelField, PlanningMaintenanceIntervalModelField, PlanningSetupTimeModelField, PlanningTimeModelField, PlanningWorkingTimeModelField, ProductFeatureModelField, ProductFunctionModelField, ProductLcpAfterUseModelField, ProductLcpDesignAndRealizationModelField, ProductLcpPuttingToUseModelField, ProductLcpUseModelField, ProductLifeCyclePhaseModelField, ProductMetadataModelField, ProductPropertyModelField, ProductVariantModelField, QualificationModelField, QualificationRoleModelField, QualificationSkillLevelModelField, QueryParams, RenditionModelField, RenditionSelectorModelField, ResultTypes, ResultViewStyles, SupplyConsumableModelField, SupplyHardwareToolModelField, SupplyLubricantModelField, SupplyModelField, SupplyOperatingModelField, SupplySparePartModelField, TokenSource, TopicModelField, TopicTypeConceptModelField, TopicTypeFormModelField, TopicTypeLearningModelField, TopicTypeModelField, TopicTypeReferenceModelField, TopicTypeTaskModelField, TopicTypeTroubleShootingModelField, VCardCalendarModelField, VCardGroupModelField, VCardImageModelField, VCardIndividualModelField, VCardInfoModelField, VCardLocationModelField, VCardModelField, VCardOrganizationModelField, WarningVars, WildCardType, articleInfoItemType, articlePageLayoutType, metaTags };
147
+ export type { AdministrativeMetadataModelField, AuditStateModelField, AuthStateModelField, CategoryModelField, ComponentModelField, ContentLifeCycleStatusModelField, ContentLifeCycleStatusValueModelField, DeviceType, DirectoryNodeModelField, DirectoryNodeTypeModelField, DocumentModelField, DocumentTypeModelField, DocumentationMetadataModelField, DocumentsType, DomainEntityModelField, EventModelField, ExternalProductGraphicModelField, ExternalProductOntologyModelField, Favorite, FileRenditionType, FilesExtensions, FragmentModelField, FunctionalMetadataModelField, IdentityDomainModelField, IdentityModelField, InformationObjectModelField, InformationSubjectCollectionModelField, InformationSubjectConformityModelField, InformationSubjectFormalityModelField, InformationSubjectFunctionalityModelField, InformationSubjectModelField, InformationSubjectProcessModelField, InformationSubjectSafetyModelField, InformationSubjectSafetyWarningMessageModelField, InformationSubjectTechnicalDataModelField, InformationSubjectTechnicalOverviewModelField, InformationTypeModelField, InformationUnitModelField, LogCategoriesType, LogLevelType, OperatorType, OwlClassModelField, PackageModelField, PartyModelField, PartyRoleModelField, PersonalizationMode, PlanningDownTimeModelField, PlanningMaintenanceIntervalModelField, PlanningSetupTimeModelField, PlanningTimeModelField, PlanningWorkingTimeModelField, PreviewUnavailableReason, ProductFeatureModelField, ProductFunctionModelField, ProductLcpAfterUseModelField, ProductLcpDesignAndRealizationModelField, ProductLcpPuttingToUseModelField, ProductLcpUseModelField, ProductLifeCyclePhaseModelField, ProductMetadataModelField, ProductPropertyModelField, ProductVariantModelField, QualificationModelField, QualificationRoleModelField, QualificationSkillLevelModelField, QueryParams, RenditionModelField, RenditionSelectorModelField, ResultTypes, ResultViewStyles, SupplyConsumableModelField, SupplyHardwareToolModelField, SupplyLubricantModelField, SupplyModelField, SupplyOperatingModelField, SupplySparePartModelField, TokenSource, TopicModelField, TopicPreview, TopicTypeConceptModelField, TopicTypeFormModelField, TopicTypeLearningModelField, TopicTypeModelField, TopicTypeReferenceModelField, TopicTypeTaskModelField, TopicTypeTroubleShootingModelField, VCardCalendarModelField, VCardGroupModelField, VCardImageModelField, VCardIndividualModelField, VCardInfoModelField, VCardLocationModelField, VCardModelField, VCardOrganizationModelField, WarningVars, WildCardType, articleInfoItemType, articlePageLayoutType, metaTags };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import * as Constants from '@c-rex/constants';
2
- import { DEVICE_OPTIONS, FILES_EXTENSIONS, LOG_CATEGORIES, ALL, LOG_LEVELS, OPERATOR_OPTIONS, PERSONALIZATION_MODES, RESULT_TYPES, RESULT_VIEW_STYLES, TOKEN_SOURCES, WILD_CARD_OPTIONS, ARTICLE_PAGE_LAYOUT } from '@c-rex/constants';
2
+ import { DEVICE_OPTIONS, FILES_EXTENSIONS, LOG_CATEGORIES, ALL, LOG_LEVELS, OPERATOR_OPTIONS, PERSONALIZATION_MODES, PREVIEW_UNAVAILABLE_REASONS, RESULT_TYPES, RESULT_VIEW_STYLES, TOKEN_SOURCES, WILD_CARD_OPTIONS, ARTICLE_PAGE_LAYOUT } from '@c-rex/constants';
3
3
 
4
4
  /**
5
5
  * Auto-generated from OpenAPI spec
@@ -101,6 +101,18 @@ type WildCardType = keyof typeof WILD_CARD_OPTIONS;
101
101
  type OperatorType = keyof typeof OPERATOR_OPTIONS;
102
102
  type TokenSource = (typeof TOKEN_SOURCES)[keyof typeof TOKEN_SOURCES];
103
103
  type PersonalizationMode = (typeof PERSONALIZATION_MODES)[keyof typeof PERSONALIZATION_MODES];
104
+ type PreviewUnavailableReason = (typeof PREVIEW_UNAVAILABLE_REASONS)[keyof typeof PREVIEW_UNAVAILABLE_REASONS];
105
+ /** Preview of a search result, as `/api/topics/{id}/preview` returns it. */
106
+ type TopicPreview = {
107
+ available: true;
108
+ title: string;
109
+ /** Sanitized HTML of the topic's own rendition, shown as it is (nothing is loaded into it). */
110
+ html: string;
111
+ } | {
112
+ available: false;
113
+ title: string;
114
+ reason: PreviewUnavailableReason;
115
+ };
104
116
  type FileRenditionType = {
105
117
  format: string;
106
118
  link: string;
@@ -132,4 +144,4 @@ type WarningVars = {
132
144
  default: any;
133
145
  };
134
146
 
135
- export type { AdministrativeMetadataModelField, AuditStateModelField, AuthStateModelField, CategoryModelField, ComponentModelField, ContentLifeCycleStatusModelField, ContentLifeCycleStatusValueModelField, DeviceType, DirectoryNodeModelField, DirectoryNodeTypeModelField, DocumentModelField, DocumentTypeModelField, DocumentationMetadataModelField, DocumentsType, DomainEntityModelField, EventModelField, ExternalProductGraphicModelField, ExternalProductOntologyModelField, Favorite, FileRenditionType, FilesExtensions, FragmentModelField, FunctionalMetadataModelField, IdentityDomainModelField, IdentityModelField, InformationObjectModelField, InformationSubjectCollectionModelField, InformationSubjectConformityModelField, InformationSubjectFormalityModelField, InformationSubjectFunctionalityModelField, InformationSubjectModelField, InformationSubjectProcessModelField, InformationSubjectSafetyModelField, InformationSubjectSafetyWarningMessageModelField, InformationSubjectTechnicalDataModelField, InformationSubjectTechnicalOverviewModelField, InformationTypeModelField, InformationUnitModelField, LogCategoriesType, LogLevelType, OperatorType, OwlClassModelField, PackageModelField, PartyModelField, PartyRoleModelField, PersonalizationMode, PlanningDownTimeModelField, PlanningMaintenanceIntervalModelField, PlanningSetupTimeModelField, PlanningTimeModelField, PlanningWorkingTimeModelField, ProductFeatureModelField, ProductFunctionModelField, ProductLcpAfterUseModelField, ProductLcpDesignAndRealizationModelField, ProductLcpPuttingToUseModelField, ProductLcpUseModelField, ProductLifeCyclePhaseModelField, ProductMetadataModelField, ProductPropertyModelField, ProductVariantModelField, QualificationModelField, QualificationRoleModelField, QualificationSkillLevelModelField, QueryParams, RenditionModelField, RenditionSelectorModelField, ResultTypes, ResultViewStyles, SupplyConsumableModelField, SupplyHardwareToolModelField, SupplyLubricantModelField, SupplyModelField, SupplyOperatingModelField, SupplySparePartModelField, TokenSource, TopicModelField, TopicTypeConceptModelField, TopicTypeFormModelField, TopicTypeLearningModelField, TopicTypeModelField, TopicTypeReferenceModelField, TopicTypeTaskModelField, TopicTypeTroubleShootingModelField, VCardCalendarModelField, VCardGroupModelField, VCardImageModelField, VCardIndividualModelField, VCardInfoModelField, VCardLocationModelField, VCardModelField, VCardOrganizationModelField, WarningVars, WildCardType, articleInfoItemType, articlePageLayoutType, metaTags };
147
+ export type { AdministrativeMetadataModelField, AuditStateModelField, AuthStateModelField, CategoryModelField, ComponentModelField, ContentLifeCycleStatusModelField, ContentLifeCycleStatusValueModelField, DeviceType, DirectoryNodeModelField, DirectoryNodeTypeModelField, DocumentModelField, DocumentTypeModelField, DocumentationMetadataModelField, DocumentsType, DomainEntityModelField, EventModelField, ExternalProductGraphicModelField, ExternalProductOntologyModelField, Favorite, FileRenditionType, FilesExtensions, FragmentModelField, FunctionalMetadataModelField, IdentityDomainModelField, IdentityModelField, InformationObjectModelField, InformationSubjectCollectionModelField, InformationSubjectConformityModelField, InformationSubjectFormalityModelField, InformationSubjectFunctionalityModelField, InformationSubjectModelField, InformationSubjectProcessModelField, InformationSubjectSafetyModelField, InformationSubjectSafetyWarningMessageModelField, InformationSubjectTechnicalDataModelField, InformationSubjectTechnicalOverviewModelField, InformationTypeModelField, InformationUnitModelField, LogCategoriesType, LogLevelType, OperatorType, OwlClassModelField, PackageModelField, PartyModelField, PartyRoleModelField, PersonalizationMode, PlanningDownTimeModelField, PlanningMaintenanceIntervalModelField, PlanningSetupTimeModelField, PlanningTimeModelField, PlanningWorkingTimeModelField, PreviewUnavailableReason, ProductFeatureModelField, ProductFunctionModelField, ProductLcpAfterUseModelField, ProductLcpDesignAndRealizationModelField, ProductLcpPuttingToUseModelField, ProductLcpUseModelField, ProductLifeCyclePhaseModelField, ProductMetadataModelField, ProductPropertyModelField, ProductVariantModelField, QualificationModelField, QualificationRoleModelField, QualificationSkillLevelModelField, QueryParams, RenditionModelField, RenditionSelectorModelField, ResultTypes, ResultViewStyles, SupplyConsumableModelField, SupplyHardwareToolModelField, SupplyLubricantModelField, SupplyModelField, SupplyOperatingModelField, SupplySparePartModelField, TokenSource, TopicModelField, TopicPreview, TopicTypeConceptModelField, TopicTypeFormModelField, TopicTypeLearningModelField, TopicTypeModelField, TopicTypeReferenceModelField, TopicTypeTaskModelField, TopicTypeTroubleShootingModelField, VCardCalendarModelField, VCardGroupModelField, VCardImageModelField, VCardIndividualModelField, VCardInfoModelField, VCardLocationModelField, VCardModelField, VCardOrganizationModelField, WarningVars, WildCardType, articleInfoItemType, articlePageLayoutType, metaTags };
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\r\n LOG_CATEGORIES,\r\n LOG_LEVELS,\r\n ALL,\r\n RESULT_VIEW_STYLES,\r\n FILES_EXTENSIONS,\r\n RESULT_TYPES,\r\n WILD_CARD_OPTIONS,\r\n ARTICLE_PAGE_LAYOUT,\r\n DEVICE_OPTIONS,\r\n OPERATOR_OPTIONS,\r\n TOKEN_SOURCES,\r\n PERSONALIZATION_MODES,\r\n} from \"@c-rex/constants\";\r\n\r\nexport * from \"./generated/model-fields\";\r\n\r\nexport type QueryParams = { key: string; value: string };\r\nexport type LogLevelType = keyof typeof LOG_LEVELS | typeof ALL;\r\nexport type LogCategoriesType = (typeof LOG_CATEGORIES)[number] | typeof ALL;\r\nexport type ResultViewStyles = (typeof RESULT_VIEW_STYLES)[number];\r\nexport type FilesExtensions = keyof typeof FILES_EXTENSIONS;\r\nexport type ResultTypes = keyof typeof RESULT_TYPES;\r\n\r\nexport type WildCardType = keyof typeof WILD_CARD_OPTIONS;\r\nexport type OperatorType = keyof typeof OPERATOR_OPTIONS;\r\nexport type TokenSource = (typeof TOKEN_SOURCES)[keyof typeof TOKEN_SOURCES];\r\nexport type PersonalizationMode =\r\n (typeof PERSONALIZATION_MODES)[keyof typeof PERSONALIZATION_MODES];\r\n\r\nexport type FileRenditionType = {\r\n format: string;\r\n link: string;\r\n};\r\n\r\nexport type articlePageLayoutType = keyof typeof ARTICLE_PAGE_LAYOUT;\r\n\r\nexport type DocumentsType = {\r\n [key: string]: {\r\n view: string;\r\n download: string;\r\n };\r\n};\r\n\r\nexport type articleInfoItemType = {\r\n label: string;\r\n value: string;\r\n link?: string;\r\n};\r\n\r\nexport type metaTags = { name: string; content: string }[];\r\n\r\nexport type DeviceType = (typeof DEVICE_OPTIONS)[keyof typeof DEVICE_OPTIONS];\r\n\r\nexport type Favorite = {\r\n id: string;\r\n label: string;\r\n color: string;\r\n};\r\n\r\nexport type WarningVars = {\r\n key: string;\r\n default: any;\r\n};\r\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\r\n LOG_CATEGORIES,\r\n LOG_LEVELS,\r\n ALL,\r\n RESULT_VIEW_STYLES,\r\n FILES_EXTENSIONS,\r\n RESULT_TYPES,\r\n WILD_CARD_OPTIONS,\r\n ARTICLE_PAGE_LAYOUT,\r\n DEVICE_OPTIONS,\r\n OPERATOR_OPTIONS,\r\n TOKEN_SOURCES,\r\n PERSONALIZATION_MODES,\r\n PREVIEW_UNAVAILABLE_REASONS,\r\n} from \"@c-rex/constants\";\r\n\r\nexport * from \"./generated/model-fields\";\r\n\r\nexport type QueryParams = { key: string; value: string };\r\nexport type LogLevelType = keyof typeof LOG_LEVELS | typeof ALL;\r\nexport type LogCategoriesType = (typeof LOG_CATEGORIES)[number] | typeof ALL;\r\nexport type ResultViewStyles = (typeof RESULT_VIEW_STYLES)[number];\r\nexport type FilesExtensions = keyof typeof FILES_EXTENSIONS;\r\nexport type ResultTypes = keyof typeof RESULT_TYPES;\r\n\r\nexport type WildCardType = keyof typeof WILD_CARD_OPTIONS;\r\nexport type OperatorType = keyof typeof OPERATOR_OPTIONS;\r\nexport type TokenSource = (typeof TOKEN_SOURCES)[keyof typeof TOKEN_SOURCES];\r\nexport type PersonalizationMode =\r\n (typeof PERSONALIZATION_MODES)[keyof typeof PERSONALIZATION_MODES];\r\n\r\nexport type PreviewUnavailableReason =\r\n (typeof PREVIEW_UNAVAILABLE_REASONS)[keyof typeof PREVIEW_UNAVAILABLE_REASONS];\r\n\r\n/** Preview of a search result, as `/api/topics/{id}/preview` returns it. */\r\nexport type TopicPreview =\r\n | {\r\n available: true;\r\n title: string;\r\n /** Sanitized HTML of the topic's own rendition, shown as it is (nothing is loaded into it). */\r\n html: string;\r\n }\r\n | {\r\n available: false;\r\n title: string;\r\n reason: PreviewUnavailableReason;\r\n };\r\n\r\nexport type FileRenditionType = {\r\n format: string;\r\n link: string;\r\n};\r\n\r\nexport type articlePageLayoutType = keyof typeof ARTICLE_PAGE_LAYOUT;\r\n\r\nexport type DocumentsType = {\r\n [key: string]: {\r\n view: string;\r\n download: string;\r\n };\r\n};\r\n\r\nexport type articleInfoItemType = {\r\n label: string;\r\n value: string;\r\n link?: string;\r\n};\r\n\r\nexport type metaTags = { name: string; content: string }[];\r\n\r\nexport type DeviceType = (typeof DEVICE_OPTIONS)[keyof typeof DEVICE_OPTIONS];\r\n\r\nexport type Favorite = {\r\n id: string;\r\n label: string;\r\n color: string;\r\n};\r\n\r\nexport type WarningVars = {\r\n key: string;\r\n default: any;\r\n};\r\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@c-rex/types",
3
- "version": "0.3.0-build.27710",
3
+ "version": "0.3.0-build.28277",
4
4
  "main": "./dist/index.js",
5
5
  "types": "./dist/index.d.ts",
6
6
  "module": "./dist/index.mjs",