@serenity-js/core 3.23.2 → 3.24.0

package/lib/screenplay/questions/q.d.ts

@@ -1,66 +0,0 @@
-import type { Answerable } from '../Answerable';
-import type { QuestionAdapter } from '../Question';
-/**
- * A Serenity/JS Screenplay Pattern-flavour
- * of a [tagged template literal](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#Tagged_templates),
- * `q` is a tag function capable of resolving any `Answerable<string>` or `Answerable<number>`
- * you parametrise it with, and returning a `QuestionAdapter<string>`.
- *
- * Use `q` to concatenate `string` and `number` values returned from synchronous an asynchronous sources.
- *
- * ## Interpolating questions
- *
- * ```ts
- * import { q, actorCalled } from '@serenity-js/core'
- * import { Send, DeleteRequest } from '@serenity-js/rest'
- * import { Text } from '@serenity-js/web'
- *
- * await actorCalled('Alice').attemptsTo(
- *   Send.a(DeleteRequest.to(
- *     q `/articles/${ Text.of(Article.id()) }`
- *   ))
- * )
- * ```
- *
- * ## Using a custom description
- *
- * ```ts
- * import { q, actorCalled } from '@serenity-js/core'
- * import { Send, DeleteRequest } from '@serenity-js/rest'
- *
- * await actorCalled('Alice').attemptsTo(
- *   Send.a(DeleteRequest.to(
- *     q `/articles/${ Text.of(Article.id()) }`.describedAs('/articles/:id')
- *   ))
- * )
- * ```
- *
- * ## Transforming the interpolated string
- *
- * The mechanism presented below relies on {@apilink QuestionAdapter}.
- *
- * ```ts
- * import { q, actorCalled } from '@serenity-js/core'
- * import { Send, DeleteRequest } from '@serenity-js/rest'
- *
- * await actorCalled('Alice').attemptsTo(
- *   Send.a(DeleteRequest.to(
- *     q `/articles/${ Text.of(Article.id()) }`.toLocaleLowerCase()
- *   ))
- * )
- * ```
- *
- * ## Learn more
- *
- * - {@apilink Answerable}
- * - {@apilink Question}
- * - {@apilink Question.describedAs}
- * - {@apilink QuestionAdapter}
- *
- * @group Questions
- *
- * @param templates
- * @param parameters
- */
-export declare function q(templates: TemplateStringsArray, ...parameters: Array<Answerable<string | number>>): QuestionAdapter<string>;
-//# sourceMappingURL=q.d.ts.map

package/lib/screenplay/questions/q.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"q.d.ts","sourceRoot":"","sources":["../../../src/screenplay/questions/q.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,wBAAgB,CAAC,CAAC,SAAS,EAAE,oBAAoB,EAAE,GAAG,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAe7H"}

package/lib/screenplay/questions/q.js

@@ -1,77 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.q = void 0;
-const Question_1 = require("../Question");
-/**
- * A Serenity/JS Screenplay Pattern-flavour
- * of a [tagged template literal](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#Tagged_templates),
- * `q` is a tag function capable of resolving any `Answerable<string>` or `Answerable<number>`
- * you parametrise it with, and returning a `QuestionAdapter<string>`.
- *
- * Use `q` to concatenate `string` and `number` values returned from synchronous an asynchronous sources.
- *
- * ## Interpolating questions
- *
- * ```ts
- * import { q, actorCalled } from '@serenity-js/core'
- * import { Send, DeleteRequest } from '@serenity-js/rest'
- * import { Text } from '@serenity-js/web'
- *
- * await actorCalled('Alice').attemptsTo(
- *   Send.a(DeleteRequest.to(
- *     q `/articles/${ Text.of(Article.id()) }`
- *   ))
- * )
- * ```
- *
- * ## Using a custom description
- *
- * ```ts
- * import { q, actorCalled } from '@serenity-js/core'
- * import { Send, DeleteRequest } from '@serenity-js/rest'
- *
- * await actorCalled('Alice').attemptsTo(
- *   Send.a(DeleteRequest.to(
- *     q `/articles/${ Text.of(Article.id()) }`.describedAs('/articles/:id')
- *   ))
- * )
- * ```
- *
- * ## Transforming the interpolated string
- *
- * The mechanism presented below relies on {@apilink QuestionAdapter}.
- *
- * ```ts
- * import { q, actorCalled } from '@serenity-js/core'
- * import { Send, DeleteRequest } from '@serenity-js/rest'
- *
- * await actorCalled('Alice').attemptsTo(
- *   Send.a(DeleteRequest.to(
- *     q `/articles/${ Text.of(Article.id()) }`.toLocaleLowerCase()
- *   ))
- * )
- * ```
- *
- * ## Learn more
- *
- * - {@apilink Answerable}
- * - {@apilink Question}
- * - {@apilink Question.describedAs}
- * - {@apilink QuestionAdapter}
- *
- * @group Questions
- *
- * @param templates
- * @param parameters
- */
-function q(templates, ...parameters) {
-    return Question_1.Question.about(templates.join('{}'), actor => Promise.all(parameters.map(parameter => actor.answer(parameter)))
-        .then(answers => templates
-        .map((template, i) => i < answers.length
-        ? [template, answers[i]]
-        : [template])
-        .reduce((acc, tuple) => acc.concat(tuple))
-        .join('')));
-}
-exports.q = q;
-//# sourceMappingURL=q.js.map

package/lib/screenplay/questions/q.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"q.js","sourceRoot":"","sources":["../../../src/screenplay/questions/q.ts"],"names":[],"mappings":";;;AAEA,0CAAuC;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,SAAgB,CAAC,CAAC,SAA+B,EAAE,GAAG,UAA8C;IAChG,OAAO,mBAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,EAAE,CAChD,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;SAC5D,IAAI,CAAC,OAAO,CAAC,EAAE,CACZ,SAAS;SACJ,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CACjB,CAAC,GAAG,OAAO,CAAC,MAAM;QACd,CAAC,CAAC,CAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAE;QAC1B,CAAC,CAAC,CAAE,QAAQ,CAAE,CAAC;SACtB,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CACnB,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CACpB;SACA,IAAI,CAAC,EAAE,CAAC,CAChB,CACR,CAAC;AACN,CAAC;AAfD,cAeC"}

package/src/io/isPlainObject.ts

@@ -1,24 +0,0 @@
-/**
- * Checks if the value has a good chance of being a plain JavaScript object
- *
- * @param v
- */
-export function isPlainObject(v: unknown): v is object {   // eslint-disable-line @typescript-eslint/ban-types
-
-    // Basic check for Type object that's not null
-    if (typeof v === 'object' && v !== null) {
-
-        // If Object.getPrototypeOf supported, use it
-        if (typeof Object.getPrototypeOf === 'function') {
-            const proto = Object.getPrototypeOf(v);
-            return proto === Object.prototype || proto === null;
-        }
-
-        // Otherwise, use internal class
-        // This should be reliable as if getPrototypeOf not supported, is pre-ES5
-        return Object.prototype.toString.call(v) === '[object Object]';
-    }
-
-    // Not an object
-    return false;
-}

package/src/io/reflection/isPrimitive.ts

@@ -1,20 +0,0 @@
-/**
- * Returns true if `value` is a [JavaScript primitive](https://developer.mozilla.org/en-US/docs/Glossary/Primitive),
- * false otherwise.
- *
- * @param value
- */
-export function isPrimitive(value: unknown): boolean {
-    if (value === null) {
-        return true;
-    }
-
-    return [
-        'string',
-        'number',
-        'bigint',
-        'boolean',
-        'undefined',
-        'symbol'
-    ].includes(typeof value);
-}

package/src/io/reflection/typeOf.ts

@@ -1,31 +0,0 @@
-import { types } from 'util';
-
-/**
- * Describes the type of the provided value.
- *
- * @param value
- */
-export function typeOf(value: unknown): string {
-    switch (true) {
-        case value === null:
-            return 'null';
-        case types.isProxy(value):
-            return `Proxy<${ Reflect.getPrototypeOf(value as object).constructor.name }>`;
-        case typeof value !== 'object':
-            return typeof value;
-        case value instanceof Date:
-            return `Date`;
-        case Array.isArray(value):
-            return `Array`;
-        case value instanceof RegExp:
-            return `RegExp`
-        case value instanceof Set:
-            return 'Set';
-        case value instanceof Map:
-            return 'Map';
-        case !! value.constructor && value.constructor !== Object:
-            return value.constructor.name
-        default:
-            return 'object';
-    }
-}

package/src/screenplay/questions/q.ts

@@ -1,82 +0,0 @@
-import type { Answerable } from '../Answerable';
-import type { QuestionAdapter } from '../Question';
-import { Question } from '../Question';
-
-/**
- * A Serenity/JS Screenplay Pattern-flavour
- * of a [tagged template literal](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#Tagged_templates),
- * `q` is a tag function capable of resolving any `Answerable<string>` or `Answerable<number>`
- * you parametrise it with, and returning a `QuestionAdapter<string>`.
- *
- * Use `q` to concatenate `string` and `number` values returned from synchronous an asynchronous sources.
- *
- * ## Interpolating questions
- *
- * ```ts
- * import { q, actorCalled } from '@serenity-js/core'
- * import { Send, DeleteRequest } from '@serenity-js/rest'
- * import { Text } from '@serenity-js/web'
- *
- * await actorCalled('Alice').attemptsTo(
- *   Send.a(DeleteRequest.to(
- *     q `/articles/${ Text.of(Article.id()) }`
- *   ))
- * )
- * ```
- *
- * ## Using a custom description
- *
- * ```ts
- * import { q, actorCalled } from '@serenity-js/core'
- * import { Send, DeleteRequest } from '@serenity-js/rest'
- *
- * await actorCalled('Alice').attemptsTo(
- *   Send.a(DeleteRequest.to(
- *     q `/articles/${ Text.of(Article.id()) }`.describedAs('/articles/:id')
- *   ))
- * )
- * ```
- *
- * ## Transforming the interpolated string
- *
- * The mechanism presented below relies on {@apilink QuestionAdapter}.
- *
- * ```ts
- * import { q, actorCalled } from '@serenity-js/core'
- * import { Send, DeleteRequest } from '@serenity-js/rest'
- *
- * await actorCalled('Alice').attemptsTo(
- *   Send.a(DeleteRequest.to(
- *     q `/articles/${ Text.of(Article.id()) }`.toLocaleLowerCase()
- *   ))
- * )
- * ```
- *
- * ## Learn more
- *
- * - {@apilink Answerable}
- * - {@apilink Question}
- * - {@apilink Question.describedAs}
- * - {@apilink QuestionAdapter}
- *
- * @group Questions
- *
- * @param templates
- * @param parameters
- */
-export function q(templates: TemplateStringsArray, ...parameters: Array<Answerable<string | number>>): QuestionAdapter<string> {
-    return Question.about(templates.join('{}'), actor =>
-        Promise.all(parameters.map(parameter => actor.answer(parameter)))
-            .then(answers =>
-                templates
-                    .map((template, i) =>
-                        i < answers.length
-                            ? [ template, answers[i] ]
-                            : [ template ])
-                    .reduce((acc, tuple) =>
-                        acc.concat(tuple)
-                    )
-                    .join('')
-            )
-    );
-}