botframework-webchat-core 4.18.1 → 4.19.0

package/src/types/external/OrgSchema/Claim.ts

@@ -1,48 +0,0 @@
-import { lazy, number, parse, string, union, type ObjectEntries } from 'valibot';
-
-import { creativeWork, type CreativeWork } from './CreativeWork';
-import { project, type Project } from './Project';
-import orgSchemaProperty from './private/orgSchemaProperty';
-
-/**
- * A [Claim](https://schema.org/Claim) in Schema.org represents a specific, factually-oriented claim that could be the [itemReviewed](https://schema.org/itemReviewed) in a [ClaimReview](https://schema.org/ClaimReview). The content of a claim can be summarized with the [text](https://schema.org/text) property. Variations on well known claims can have their common identity indicated via [sameAs](https://schema.org/sameAs) links, and summarized with a name. Ideally, a [Claim](https://schema.org/Claim) description includes enough contextual information to minimize the risk of ambiguity or inclarity. In practice, many claims are better understood in the context in which they appear or the interpretations provided by claim reviews.
- *
- * Beyond [ClaimReview](https://schema.org/ClaimReview), the Claim type can be associated with related creative works - for example a [ScholarlyArticle](https://schema.org/ScholarlyArticle) or [Question](https://schema.org/Question) might be about some [Claim](https://schema.org/Claim).
- *
- * This is partial implementation of https://schema.org/Claim.
- *
- * @see https://schema.org/Claim.
- */
-export type Claim = CreativeWork & {
-  /**
-   * Indicates an occurrence of a [Claim](https://schema.org/Claim) in some [CreativeWork](https://schema.org/CreativeWork).
-   *
-   * @see https://schema.org/appearance.
-   */
-  appearance?: CreativeWork | undefined;
-
-  /**
-   * For a [Claim](https://schema.org/Claim) interpreted from [MediaObject](https://schema.org/MediaObject) content sed to indicate a claim contained, implied or refined from the content of a [MediaObject](https://schema.org/MediaObject).
-   *
-   * @see https://schema.org/claimInterpreter.
-   */
-  claimInterpreter?: Project | undefined;
-
-  /**
-   * The position of an item in a series or sequence of items.
-   *
-   * @see https://schema.org/position.
-   */
-  position?: number | string;
-};
-
-export const claim = <TEntries extends ObjectEntries>(entries?: TEntries | undefined) =>
-  creativeWork({
-    appearance: orgSchemaProperty(lazy(() => creativeWork())),
-    claimInterpreter: orgSchemaProperty(lazy(() => project())),
-    position: orgSchemaProperty(union([number(), string()])),
-
-    ...entries
-  });
-
-export const parseClaim = (data: unknown): Claim => parse(claim(), data);

package/src/types/external/OrgSchema/CreativeWork.parseCreativeWork.spec.ts

@@ -1,51 +0,0 @@
-import { parseCreativeWork } from './CreativeWork';
-
-describe('CreativeWork', () => {
-  test('should parse properties from Thing', () =>
-    expect(
-      parseCreativeWork({
-        '@type': 'CreativeWork',
-        name: 'Business @ the Speed of Thought'
-      })
-    ).toEqual({
-      '@type': 'CreativeWork',
-      name: 'Business @ the Speed of Thought'
-    }));
-
-  test('should parse thing of Book type', () =>
-    expect(
-      parseCreativeWork({
-        '@type': 'Book',
-        name: 'Business @ the Speed of Thought'
-      })
-    ).toEqual({
-      '@type': 'Book',
-      name: 'Business @ the Speed of Thought'
-    }));
-
-  test('should parse citation (singular)', () =>
-    expect(
-      parseCreativeWork({
-        '@type': 'Book',
-        name: 'Business @ the Speed of Thought',
-        citation: { '@type': 'Book', name: 'The Road Ahead' }
-      })
-    ).toEqual({
-      '@type': 'Book',
-      name: 'Business @ the Speed of Thought',
-      citation: [{ '@type': 'Book', name: 'The Road Ahead' }]
-    }));
-
-  test('should parse citation (plural)', () =>
-    expect(
-      parseCreativeWork({
-        '@type': 'Book',
-        name: 'Business @ the Speed of Thought',
-        citation: [{ '@type': 'Book', name: 'The Road Ahead' }]
-      })
-    ).toEqual({
-      '@type': 'Book',
-      name: 'Business @ the Speed of Thought',
-      citation: [{ '@type': 'Book', name: 'The Road Ahead' }]
-    }));
-});

package/src/types/external/OrgSchema/CreativeWork.ts

@@ -1,83 +0,0 @@
-import { lazy, parse, string, union, type ObjectEntries } from 'valibot';
-
-import { definedTerm, type DefinedTerm } from './DefinedTerm';
-import orgSchemaProperties from './private/orgSchemaProperties';
-import orgSchemaProperty from './private/orgSchemaProperty';
-import { thing, type Thing } from './Thing';
-
-/**
- * The most generic kind of creative work, including books, movies, photographs, software programs, etc.
- *
- * This is partial implementation of https://schema.org/CreativeWork.
- *
- * @see https://schema.org/CreativeWork
- */
-// Due to limitations of TypeScript, when using valibot.lazy(), the output type must be explicitly set.
-export type CreativeWork = Thing & {
-  /**
-   * An abstract is a short description that summarizes a [CreativeWork](https://schema.org/CreativeWork).
-   *
-   * @see https://schema.org/abstract
-   */
-  abstract?: string | undefined;
-
-  /**
-   * The author of this content or rating. Please note that author is special in that HTML 5 provides a special mechanism for indicating authorship via the rel tag. That is equivalent to this and may be used interchangeably.
-   *
-   * @see https://schema.org/author
-   */
-  author?: string | undefined;
-
-  /**
-   * A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
-   *
-   * @see https://schema.org/citation
-   */
-  citation?: readonly CreativeWork[] | undefined;
-
-  /**
-   * Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
-   *
-   * @see https://schema.org/keywords
-   */
-  keywords?: readonly (DefinedTerm | string)[] | undefined;
-
-  /**
-   * A pattern that something has, for example 'polka dot', 'striped', 'Canadian flag'. Values are typically expressed as text, although links to controlled value schemes are also supported.
-   *
-   * @see https://schema.org/pattern
-   */
-  pattern?: DefinedTerm | undefined;
-
-  /**
-   * The textual content of this CreativeWork.
-   *
-   * @see https://schema.org/text
-   */
-  text?: string | undefined;
-
-  /**
-   * The schema.org [usageInfo](https://schema.org/usageInfo) property indicates further information about a [CreativeWork](https://schema.org/CreativeWork). This property is applicable both to works that are freely available and to those that require payment or other transactions. It can reference additional information, e.g. community expectations on preferred linking and citation conventions, as well as purchasing details. For something that can be commercially licensed, usageInfo can provide detailed, resource-specific information about licensing options.
-   *
-   * This property can be used alongside the license property which indicates license(s) applicable to some piece of content. The usageInfo property can provide information about other licensing options, e.g. acquiring commercial usage rights for an image that is also available under non-commercial creative commons licenses.
-   */
-  usageInfo?: CreativeWork | undefined;
-};
-
-export const creativeWork = <TEntries extends ObjectEntries>(entries?: TEntries | undefined) =>
-  thing({
-    // For forward compatibility, we did not enforce @type must be "CreativeWork" or any other subtypes.
-    // In future, if Schema.org introduced a new subtype of CreativeWork, we should still able to parse that one as a CreativeWork.
-
-    abstract: orgSchemaProperty(string()),
-    author: orgSchemaProperties(string()),
-    citation: orgSchemaProperties(lazy(() => creativeWork())),
-    keywords: orgSchemaProperties(union([lazy(() => definedTerm()), string()])),
-    pattern: orgSchemaProperty(lazy(() => definedTerm())),
-    text: orgSchemaProperty(string()),
-    usageInfo: orgSchemaProperty(lazy(() => creativeWork())),
-
-    ...entries
-  });
-
-export const parseCreativeWork = (data: unknown): CreativeWork => parse(creativeWork(), data);

package/src/types/external/OrgSchema/DefinedTerm.ts

@@ -1,37 +0,0 @@
-import { parse, string, type ObjectEntries } from 'valibot';
-
-import { thing, type Thing } from './Thing';
-import orgSchemaProperty from './private/orgSchemaProperty';
-
-export const definedTerm = <TEntries extends ObjectEntries>(entries?: TEntries | undefined) =>
-  thing({
-    inDefinedTermSet: orgSchemaProperty(string()),
-    termCode: orgSchemaProperty(string()),
-
-    ...entries
-  });
-
-/**
- * A word, name, acronym, phrase, etc. with a formal definition. Often used in the context of category or subject classification, glossaries or dictionaries, product or creative work types, etc. Use the name property for the term being defined, use termCode if the term has an alpha-numeric code allocated, use description to provide the definition of the term.
- *
- * This is partial implementation of https://schema.org/DefinedTerm.
- *
- * @see https://schema.org/DefinedTerm
- */
-export type DefinedTerm = Thing & {
-  /**
-   * A [DefinedTermSet](https://schema.org/DefinedTermSet) that contains this term.
-   *
-   * @see https://schema.org/inDefinedTermSet
-   */
-  inDefinedTermSet?: string | undefined;
-
-  /**
-   * A code that identifies this [DefinedTerm](https://schema.org/DefinedTerm) within a [DefinedTermSet](https://schema.org/DefinedTermSet).
-   *
-   * @see https://schema.org/termCode
-   */
-  termCode?: string | undefined;
-};
-
-export const parseDefinedTerm = (data: unknown): DefinedTerm => parse(definedTerm(), data);

package/src/types/external/OrgSchema/Project.parseProject.spec.ts

@@ -1,17 +0,0 @@
-import { parseProject } from './Project';
-
-describe('Project', () => {
-  test('should parse', () => {
-    expect(
-      parseProject({
-        '@type': 'Project',
-        name: 'Microsoft',
-        slogan: 'Empower every person and every organization on the planet to achieve more.'
-      })
-    ).toEqual({
-      '@type': 'Project',
-      name: 'Microsoft',
-      slogan: 'Empower every person and every organization on the planet to achieve more.'
-    });
-  });
-});

package/src/types/external/OrgSchema/Project.ts

@@ -1,29 +0,0 @@
-import { parse, string, type ObjectEntries } from 'valibot';
-
-import { thing, type Thing } from './Thing';
-import orgSchemaProperty from './private/orgSchemaProperty';
-
-export const project = <TEntries extends ObjectEntries>(entries?: TEntries | undefined) =>
-  thing({
-    slogan: orgSchemaProperty(string()),
-
-    ...entries
-  });
-
-/**
- * An enterprise (potentially individual but typically collaborative), planned to achieve a particular aim. Use properties from [Organization](https://schema.org/Organization), [subOrganization](https://schema.org/subOrganization)/[parentOrganization](https://schema.org/parentOrganization) to indicate project sub-structures.
- *
- * This is partial implementation of https://schema.org/Project.
- *
- * @see https://schema.org/Project
- */
-export type Project = Thing & {
-  /**
-   * A slogan or motto associated with the item.
-   *
-   * @see https://schema.org/slogan
-   */
-  slogan?: string | undefined;
-};
-
-export const parseProject = (data: unknown): Project => parse(project(), data);

package/src/types/external/OrgSchema/Thing.parseThing.spec.ts

@@ -1,54 +0,0 @@
-import { parseThing } from './Thing';
-
-describe('Thing', () => {
-  test('should parse', () => {
-    expect(
-      parseThing({
-        '@type': 'Thing',
-        name: 'John Doe'
-      })
-    ).toEqual({
-      '@type': 'Thing',
-      name: 'John Doe'
-    });
-  });
-
-  test('should parse unknown @type', () => {
-    expect(
-      parseThing({
-        '@type': 'Unknown',
-        name: 'John Doe'
-      })
-    ).toEqual({
-      '@type': 'Unknown',
-      name: 'John Doe'
-    });
-  });
-
-  // This is an intentional drift from JSON-LD.
-  // Assuming expecting an object of Thing while the actual is CreativeWork.
-  // If unknown properties are removed, we will remove properties that are solely for CreativeWork.
-  test('should not remove unknown properties', () => {
-    expect(
-      parseThing({
-        '@type': 'Thing',
-        something: 1
-      })
-    ).toEqual({
-      '@type': 'Thing',
-      something: 1
-    });
-  });
-
-  test('should set invalid properties to undefined', () => {
-    expect(
-      parseThing({
-        '@type': 'Thing',
-        name: 1
-      })
-    ).toEqual({
-      '@type': 'Thing',
-      name: undefined
-    });
-  });
-});

package/src/types/external/OrgSchema/Thing.ts

@@ -1,94 +0,0 @@
-import { type EmptyObject } from 'type-fest';
-import { lazy, object, optional, parse, string, unknown, value, type ObjectEntries, type StringSchema } from 'valibot';
-
-import { action, type Action } from './Action';
-import orgSchemaProperties from './private/orgSchemaProperties';
-import orgSchemaProperty from './private/orgSchemaProperty';
-
-/**
- * The most generic type of item.
- *
- * This is partial implementation of https://schema.org/Thing.
- *
- * @see https://schema.org/Thing
- */
-export type Thing = {
-  '@context'?: 'https://schema.org' | undefined;
-  '@id'?: string | undefined;
-  '@type': string;
-
-  /**
-   * An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. Typically the value is a URI-identified RDF class, and in this case corresponds to the use of rdf:type in RDF. Text values can be used sparingly, for cases where useful information can be added without their being an appropriate schema to reference. In the case of text values, the class label should follow the schema.org [style guide](https://schema.org/docs/styleguide.html).
-   *
-   * @see https://schema.org/additionalType
-   */
-  additionalType?: string | undefined;
-
-  /**
-   * An alias for the item.
-   *
-   * @see https://schema.org/alternateName
-   */
-  alternateName?: string | undefined;
-
-  /**
-   * A description of the item.
-   *
-   * @see https://schema.org/description
-   */
-  description?: string | undefined;
-
-  /**
-   * The name of the item.
-   *
-   * @see https://schema.org/name
-   */
-  name?: string | undefined;
-
-  /**
-   * Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
-   *
-   * @see https://schema.org/potentialAction
-   */
-  potentialAction?: readonly Action[] | undefined;
-
-  /**
-   * URL of the item.
-   *
-   * @see https://schema.org/url
-   */
-  url?: string | undefined;
-};
-
-const thingEntries = {
-  '@context': optional(string([value('https://schema.org')]) as StringSchema<'https://schema.org'>),
-  '@id': optional(string()),
-  '@type': string(),
-
-  additionalType: orgSchemaProperty(string()),
-  alternateName: orgSchemaProperty(string()),
-  description: orgSchemaProperty(string()),
-  name: orgSchemaProperty(string()),
-  potentialAction: orgSchemaProperties(lazy(() => action())),
-  url: orgSchemaProperty(string())
-};
-
-export const thing = <TEntries extends ObjectEntries>(entries?: TEntries | undefined) =>
-  object(
-    {
-      ...thingEntries,
-      ...entries
-    },
-    // Forward compatibility is the reason why we use unknown() here and not adhere to JSON-LD which drop unknown fields.
-    //
-    // Example:
-    // - CreativeWork.editor must be type of Person (or any of its subtypes, Patient)
-    // - Without unknown(), when we parse the CreativeWork, we will drop Patient.diagnosis
-    // - That means, CreativeWork.editor.diagnosis will be unset despite CreativeWork.editor is of type Patient
-    //
-    // We can drop unknown() if there is a way to keep CreativeWork.editor.diagnosis.
-    // It is okay to drop future/unsupported properties. But not today/supported properties.
-    unknown()
-  );
-
-export const parseThing = (data: unknown): Thing => parse(thing<EmptyObject>(), data);

package/src/types/external/OrgSchema/VoteAction.spec.ts

@@ -1,35 +0,0 @@
-import { parseVoteAction } from './VoteAction';
-
-describe('VoteAction', () => {
-  describe('actionOption', () => {
-    test('should parse', () =>
-      expect(
-        parseVoteAction({
-          '@type': 'VoteAction',
-          actionOption: 'upvote'
-        })
-      ).toEqual({
-        '@type': 'VoteAction',
-        actionOption: 'upvote'
-      }));
-
-    test('should change invalid into undefined', () => {
-      try {
-        expect(
-          parseVoteAction({
-            '@type': 'Action',
-            actionOption: 123
-          })
-        ).toEqual({
-          '@type': 'Action',
-          actionOption: undefined
-        });
-      } catch (err) {
-        console.error(err);
-        console.error(err.issues[0].input);
-
-        throw err;
-      }
-    });
-  });
-});

package/src/types/external/OrgSchema/VoteAction.ts

@@ -1,31 +0,0 @@
-import { parse, string, type ObjectEntries } from 'valibot';
-
-import { action, type Action } from './Action';
-import orgSchemaProperty from './private/orgSchemaProperty';
-
-/**
- * An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument. The execution of the action may produce a result. Specific action sub-type documentation specifies the exact expectation of each argument/role.
- *
- * See also [blog post](http://blog.schema.org/2014/04/announcing-schemaorg-actions.html) and [Actions overview document](https://schema.org/docs/actions.html).
- *
- * This is partial implementation of https://schema.org/Action.
- *
- * @see https://schema.org/Action
- */
-export type VoteAction = Action & {
-  /**
-   * A sub property of object. The options subject to this action. Supersedes [option](https://schema.org/option).
-   *
-   * @see https://schema.org/VoteAction
-   */
-  actionOption?: string | undefined;
-};
-
-export const voteAction = <TEntries extends ObjectEntries>(entries?: TEntries | undefined) =>
-  action({
-    actionOption: orgSchemaProperty(string()),
-
-    ...entries
-  });
-
-export const parseVoteAction = (data: unknown): VoteAction => parse(voteAction(), data);

package/src/types/external/OrgSchema/private/orgSchemaProperties.spec.ts

@@ -1,41 +0,0 @@
-import { parse, string } from 'valibot';
-
-import orgSchemaProperties from './orgSchemaProperties';
-
-describe('orgSchemaProperties', () => {
-  describe('singular', () => {
-    test('should transform into plural', () => {
-      expect(parse(orgSchemaProperties(string()), 'abc')).toEqual(['abc']);
-    });
-
-    test('should turn item of invalid type into undefined', () => {
-      expect(parse(orgSchemaProperties(string()), 0)).toBeUndefined();
-    });
-
-    test('should turn null into undefined', () => {
-      expect(parse(orgSchemaProperties(string()), null)).toBeUndefined();
-    });
-
-    test('should keep undefined as-is', () => {
-      expect(parse(orgSchemaProperties(string()), undefined)).toBeUndefined();
-    });
-  });
-
-  describe('plural', () => {
-    test('should keep as-is', () => {
-      expect(parse(orgSchemaProperties(string()), ['abc', 'xyz'])).toEqual(['abc', 'xyz']);
-    });
-
-    test('should keep empty array as-is', () => {
-      expect(parse(orgSchemaProperties(string()), [])).toEqual([]);
-    });
-
-    test('should remove items with invalid type (all)', () => {
-      expect(parse(orgSchemaProperties(string()), [0])).toEqual([]);
-    });
-
-    test('should remove items with invalid type (some)', () => {
-      expect(parse(orgSchemaProperties(string()), ['abc', 0, 'xyz'])).toEqual(['abc', 'xyz']);
-    });
-  });
-});

package/src/types/external/OrgSchema/private/orgSchemaProperties.ts

@@ -1,23 +0,0 @@
-import {
-  array,
-  fallback,
-  parse,
-  transform,
-  type ArraySchema,
-  type BaseSchema,
-  type FallbackInfo,
-  type Output,
-  type UndefinedSchema
-} from 'valibot';
-
-import orgSchemaProperty from './orgSchemaProperty';
-
-const singularToArray = <T extends BaseSchema>(schema: T): ArraySchema<T> | UndefinedSchema =>
-  fallback<ArraySchema<T> | UndefinedSchema, (info?: FallbackInfo) => Output<T>>(
-    transform(array(schema), value => value.filter(value => typeof value !== 'undefined')),
-    value => (value?.input ? [parse(schema, value?.input)] : undefined)
-  );
-
-export default function orgSchemaProperties<T extends BaseSchema>(schema: T) {
-  return singularToArray(orgSchemaProperty(schema));
-}

package/src/types/external/OrgSchema/private/orgSchemaProperty.spec.ts

@@ -1,21 +0,0 @@
-import { parse, string } from 'valibot';
-
-import orgSchemaProperty from './orgSchemaProperty';
-
-describe('orgSchemaProperty', () => {
-  test('should keep valid type as-is', () => {
-    expect(parse(orgSchemaProperty(string()), 'abc')).toBe('abc');
-  });
-
-  test('should keep undefined as-is', () => {
-    expect(parse(orgSchemaProperty(string()), undefined)).toBeUndefined();
-  });
-
-  test('should convert invalid type to undefined', () => {
-    expect(parse(orgSchemaProperty(string()), null)).toBeUndefined();
-  });
-
-  test('should take the first item from an array', () => {
-    expect(parse(orgSchemaProperty(string()), ['abc', 'def', 'xyz'])).toBe('abc');
-  });
-});

package/src/types/external/OrgSchema/private/orgSchemaProperty.ts

@@ -1,6 +0,0 @@
-import { array, fallback, optional, transform, union, type BaseSchema } from 'valibot';
-
-const orgSchemaProperty = <T extends BaseSchema>(schema: T) =>
-  fallback(optional(union([transform(array(schema), array => array[0]), schema])), undefined);
-
-export default orgSchemaProperty;

package/src/utils/isForbiddenPropertyName.spec.js

@@ -1,6 +0,0 @@
-import isForbiddenPropertyName from './isForbiddenPropertyName';
-
-test('should forbid "__proto__"', () => expect(isForbiddenPropertyName('__proto__')).toBeTruthy());
-test('should forbid "constructor"', () => expect(isForbiddenPropertyName('constructor')).toBeTruthy());
-test('should forbid "prototype"', () => expect(isForbiddenPropertyName('prototype')).toBeTruthy());
-test('should not forbid "abc"', () => expect(isForbiddenPropertyName('abc')).toBeFalsy());

package/src/utils/isForbiddenPropertyName.ts

@@ -1,33 +0,0 @@
-let FORBIDDEN_PROPERTY_NAMES;
-
-function getForbiddenPropertyNames(): string[] {
-  return (
-    FORBIDDEN_PROPERTY_NAMES ||
-    (FORBIDDEN_PROPERTY_NAMES = Object.freeze(
-      Array.from(
-        new Set([
-          // As-of writing, `Object.prototype` includes:
-          //   __defineGetter__
-          //   __defineSetter__
-          //   __lookupGetter__
-          //   __lookupSetter
-          //   __proto__
-          //   constructor
-          //   hasOwnProperty
-          //   isPrototypeOf
-          //   propertyIsEnumerable
-          //   toLocaleString
-          //   toString
-          //   valueOf
-          ...Object.getOwnPropertyNames(Object.prototype),
-
-          'prototype'
-        ])
-      )
-    ))
-  );
-}
-
-export default function isForbiddenPropertyName(propertyName: string): boolean {
-  return getForbiddenPropertyNames().includes(propertyName);
-}

package/src/utils/singleToArray.ts

@@ -1,3 +0,0 @@
-export default function singleToArray<T>(singleOrArray: T | T[]): T[] {
-  return singleOrArray ? (Array.isArray(singleOrArray) ? singleOrArray : [singleOrArray]) : [];
-}

package/src/utils/warnOnce.ts

@@ -1,5 +0,0 @@
-import once from './once';
-
-export default function warnOnce(message: string): () => void {
-  return once(() => console.warn(`botframework-webchat: ${message}.`));
-}