@inkeep/cxkit-primitives 0.5.15 → 0.5.17

package/dist/utils/tools/links-schema.d.cts

@@ -1,64 +0,0 @@
-export declare const linksSchema: {
-    type: string;
-    properties: {
-        links: {
-            anyOf: ({
-                type: string;
-                items: {
-                    type: string;
-                    properties: {
-                        label: {
-                            type: string[];
-                        };
-                        url: {
-                            type: string;
-                        };
-                        title: {
-                            type: string[];
-                        };
-                        description: {
-                            type: string[];
-                        };
-                        type: {
-                            anyOf: ({
-                                anyOf: ({
-                                    type: string;
-                                    enum: string[];
-                                } | {
-                                    type: string;
-                                    enum?: undefined;
-                                })[];
-                                type?: undefined;
-                            } | {
-                                type: string;
-                                anyOf?: undefined;
-                            })[];
-                        };
-                        breadcrumbs: {
-                            anyOf: ({
-                                type: string;
-                                items: {
-                                    type: string;
-                                };
-                            } | {
-                                type: string;
-                                items?: undefined;
-                            })[];
-                        };
-                    };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
-            } | {
-                type: string;
-                items?: undefined;
-            })[];
-        };
-        text: {
-            type: string;
-        };
-    };
-    required: string[];
-    additionalProperties: boolean;
-    $schema: string;
-};

package/dist/utils/tools/links-schema.d.ts

@@ -1,64 +0,0 @@
-export declare const linksSchema: {
-    type: string;
-    properties: {
-        links: {
-            anyOf: ({
-                type: string;
-                items: {
-                    type: string;
-                    properties: {
-                        label: {
-                            type: string[];
-                        };
-                        url: {
-                            type: string;
-                        };
-                        title: {
-                            type: string[];
-                        };
-                        description: {
-                            type: string[];
-                        };
-                        type: {
-                            anyOf: ({
-                                anyOf: ({
-                                    type: string;
-                                    enum: string[];
-                                } | {
-                                    type: string;
-                                    enum?: undefined;
-                                })[];
-                                type?: undefined;
-                            } | {
-                                type: string;
-                                anyOf?: undefined;
-                            })[];
-                        };
-                        breadcrumbs: {
-                            anyOf: ({
-                                type: string;
-                                items: {
-                                    type: string;
-                                };
-                            } | {
-                                type: string;
-                                items?: undefined;
-                            })[];
-                        };
-                    };
-                    required: string[];
-                    additionalProperties: boolean;
-                };
-            } | {
-                type: string;
-                items?: undefined;
-            })[];
-        };
-        text: {
-            type: string;
-        };
-    };
-    required: string[];
-    additionalProperties: boolean;
-    $schema: string;
-};

package/dist/utils/transform-source/breadcrumbs.d.cts

@@ -1,2 +0,0 @@
-import { SourceItem, TransformSourceOptions } from '@inkeep/cxkit-types';
-export declare const getBreadcrumbs: (source: SourceItem, opts?: TransformSourceOptions) => string[];

package/dist/utils/transform-source/breadcrumbs.d.ts

@@ -1,2 +0,0 @@
-import { SourceItem, TransformSourceOptions } from '@inkeep/cxkit-types';
-export declare const getBreadcrumbs: (source: SourceItem, opts?: TransformSourceOptions) => string[];

package/dist/utils/transform-source/common-words/long.d.cts

@@ -1 +0,0 @@
-export declare const long: string[];

package/dist/utils/transform-source/common-words/long.d.ts

@@ -1 +0,0 @@
-export declare const long: string[];

package/dist/utils/transform-source/common-words/lowercase.d.cts

@@ -1 +0,0 @@
-export declare const lowercase: string[];

package/dist/utils/transform-source/common-words/lowercase.d.ts

@@ -1 +0,0 @@
-export declare const lowercase: string[];

package/dist/utils/transform-source/common-words/short.d.cts

@@ -1 +0,0 @@
-export declare const short: string[];

package/dist/utils/transform-source/common-words/short.d.ts

@@ -1 +0,0 @@
-export declare const short: string[];

package/dist/utils/transform-source/description.d.cts

@@ -1,2 +0,0 @@
-import { SourceItem, TransformSourceType } from '@inkeep/cxkit-types';
-export declare const getDescription: (source: SourceItem, type: TransformSourceType) => string | undefined;

package/dist/utils/transform-source/description.d.ts

@@ -1,2 +0,0 @@
-import { SourceItem, TransformSourceType } from '@inkeep/cxkit-types';
-export declare const getDescription: (source: SourceItem, type: TransformSourceType) => string | undefined;

package/dist/utils/transform-source/icon.d.cts

@@ -1,2 +0,0 @@
-import { InkeepCustomIcon, SourceItem } from '@inkeep/cxkit-types';
-export declare const getIcon: (source: SourceItem) => InkeepCustomIcon;

package/dist/utils/transform-source/icon.d.ts

@@ -1,2 +0,0 @@
-import { InkeepCustomIcon, SourceItem } from '@inkeep/cxkit-types';
-export declare const getIcon: (source: SourceItem) => InkeepCustomIcon;

package/dist/utils/transform-source/tabs.d.cts

@@ -1,2 +0,0 @@
-import { SourceItem, TransformSourceOptions, SourceTab } from '@inkeep/cxkit-types';
-export declare const getTabs: (source: SourceItem, opts?: TransformSourceOptions) => (string | SourceTab)[];

package/dist/utils/transform-source/tabs.d.ts

@@ -1,2 +0,0 @@
-import { SourceItem, TransformSourceOptions, SourceTab } from '@inkeep/cxkit-types';
-export declare const getTabs: (source: SourceItem, opts?: TransformSourceOptions) => (string | SourceTab)[];

package/dist/utils/transform-source/title.d.cts

@@ -1,2 +0,0 @@
-import { SourceItem, TransformSourceOptions } from '@inkeep/cxkit-types';
-export declare const getTitle: (source: SourceItem, opts?: TransformSourceOptions) => string;

package/dist/utils/transform-source/title.d.ts

@@ -1,2 +0,0 @@
-import { SourceItem, TransformSourceOptions } from '@inkeep/cxkit-types';
-export declare const getTitle: (source: SourceItem, opts?: TransformSourceOptions) => string;

package/dist/utils/transform-source/utils/description-without-title.d.cts

@@ -1,11 +0,0 @@
-/**
- * Some sources include the title in the description.
- *
- * This function removes the title from the description.
- * It handles both plain and em-wrapped titles.
- *
- * @param description - The description to remove the title from.
- * @param title - The title to remove from the description.
- * @returns The description without the title.
- */
-export declare function descriptionWithoutTitle(description: string | undefined, title: string | undefined): string | undefined;

package/dist/utils/transform-source/utils/description-without-title.d.ts

@@ -1,11 +0,0 @@
-/**
- * Some sources include the title in the description.
- *
- * This function removes the title from the description.
- * It handles both plain and em-wrapped titles.
- *
- * @param description - The description to remove the title from.
- * @param title - The title to remove from the description.
- * @returns The description without the title.
- */
-export declare function descriptionWithoutTitle(description: string | undefined, title: string | undefined): string | undefined;

package/dist/utils/transform-source/utils/index.d.cts

@@ -1,6 +0,0 @@
-export * from './misc';
-export * from './standardize-organization-display-name';
-export * from './strip-branding-keywords';
-export * from './description-without-title';
-export * from './standardize-suffixes';
-export * from './standardize-common-words';

package/dist/utils/transform-source/utils/index.d.ts

@@ -1,6 +0,0 @@
-export * from './misc';
-export * from './standardize-organization-display-name';
-export * from './strip-branding-keywords';
-export * from './description-without-title';
-export * from './standardize-suffixes';
-export * from './standardize-common-words';

package/dist/utils/transform-source/utils/misc.d.cts

@@ -1,2 +0,0 @@
-export declare function isGitHubUrl(url: string): boolean;
-export declare function isTitleCase(str: string): boolean;

package/dist/utils/transform-source/utils/misc.d.ts

@@ -1,2 +0,0 @@
-export declare function isGitHubUrl(url: string): boolean;
-export declare function isTitleCase(str: string): boolean;

package/dist/utils/transform-source/utils/standardize-common-words.d.cts

@@ -1 +0,0 @@
-export declare function transformCommonWords(text: string): string;

package/dist/utils/transform-source/utils/standardize-common-words.d.ts

@@ -1 +0,0 @@
-export declare function transformCommonWords(text: string): string;

package/dist/utils/transform-source/utils/standardize-organization-display-name.d.cts

@@ -1,8 +0,0 @@
-/**
-/**
- * Standardize the organization display name in the text
- *
- * If someone writes your organization name with different casing (e.g., “InKeep,” “INKEEP”),
- * the rule will enforce a consistent, normalized spelling (e.g., “Inkeep”)
- */
-export declare function standardizeOrganizationDisplayName(text: string, organization: string): string;

package/dist/utils/transform-source/utils/standardize-organization-display-name.d.ts

@@ -1,8 +0,0 @@
-/**
-/**
- * Standardize the organization display name in the text
- *
- * If someone writes your organization name with different casing (e.g., “InKeep,” “INKEEP”),
- * the rule will enforce a consistent, normalized spelling (e.g., “Inkeep”)
- */
-export declare function standardizeOrganizationDisplayName(text: string, organization: string): string;

package/dist/utils/transform-source/utils/standardize-suffixes.d.cts

@@ -1,5 +0,0 @@
-export declare const suffixMap: Record<string, string>;
-/**
- * Standardizes given suffixes in a string.
- */
-export declare function standardizeSuffixes(text: string): string;

package/dist/utils/transform-source/utils/standardize-suffixes.d.ts

@@ -1,5 +0,0 @@
-export declare const suffixMap: Record<string, string>;
-/**
- * Standardizes given suffixes in a string.
- */
-export declare function standardizeSuffixes(text: string): string;

package/dist/utils/transform-source/utils/strip-branding-keywords.d.cts

@@ -1,17 +0,0 @@
-/**
- * Strip common branding keywords and organization name from the text
- *
- * This function removes branding elements from text in the following formats:
- * - Organization name or keywords at start/end with pipe, hyphen or colon separator
- * - Organization name with optional domain suffix (.com, .ai, etc)
- * - Common documentation keywords like "API", "Docs", etc.
- *
- * @example
- * Given the organizationDisplayName 'inkeep', it would match and replace:
- * 'Inkeep | Some Title' -> 'Some Title'
- * 'Some Title - INKEEP' -> 'Some Title'
- * 'inkeep.ai: Title' -> 'Title'
- * 'Title | Inkeep.com' -> 'Title'
- * 'API Documentation | Title' -> 'Title'
- */
-export declare function stripBrandingKeywords(text: string, organization: string): string;

package/dist/utils/transform-source/utils/strip-branding-keywords.d.ts

@@ -1,17 +0,0 @@
-/**
- * Strip common branding keywords and organization name from the text
- *
- * This function removes branding elements from text in the following formats:
- * - Organization name or keywords at start/end with pipe, hyphen or colon separator
- * - Organization name with optional domain suffix (.com, .ai, etc)
- * - Common documentation keywords like "API", "Docs", etc.
- *
- * @example
- * Given the organizationDisplayName 'inkeep', it would match and replace:
- * 'Inkeep | Some Title' -> 'Some Title'
- * 'Some Title - INKEEP' -> 'Some Title'
- * 'inkeep.ai: Title' -> 'Title'
- * 'Title | Inkeep.com' -> 'Title'
- * 'API Documentation | Title' -> 'Title'
- */
-export declare function stripBrandingKeywords(text: string, organization: string): string;