@magda/arbitraries 1.1.0-alpha.2 → 1.1.0-rc.0

package/dist/index.d.ts

@@ -0,0 +1,157 @@
+/// <reference types="node" />
+import jsc from 'jsverify';
+
+export declare function arbFlatMap<T, U>(arb: jsc.Arbitrary<T>, arbForward: (t: T) => jsc.Arbitrary<U>, backwards: (u: U) => T, show?: (u: U) => string | undefined): MonadicArb<U>;
+
+/** Generates an array that is guaranteed to be of the supplied size */
+export declare function arrayOfSizeArb<T>(size: number, arb: jsc.Arbitrary<T>): jsc.Arbitrary<T[]>;
+
+/**
+ *
+ */
+export declare const datasetFormatArb: ({ format }: DatasetFormatOverrideArbs) => jsc.Arbitrary<{
+    format: string;
+}>;
+
+/**
+ * Can be passed into datasetFormatArb to override the default arbitaries.
+ */
+export declare type DatasetFormatOverrideArbs = {
+    format?: jsc.Arbitrary<string>;
+};
+
+export declare const dateStringArb: jsc.Arbitrary<string>;
+
+/**
+ * Generates the content of a distribution's dcat-distribution-strings aspect.
+ */
+export declare const distStringsArb: ({ url, license, format }: DistStringsOverrideArbs) => jsc.Arbitrary<{
+    downloadURL: string;
+    accessURL: string;
+    license: string;
+    format: string;
+}>;
+
+/**
+ * Can be passed into distStringsArb to override the default arbitraries.
+ */
+export declare type DistStringsOverrideArbs = {
+    url?: jsc.Arbitrary<string>;
+    license?: jsc.Arbitrary<string>;
+    format?: jsc.Arbitrary<string>;
+};
+
+/** Generates a URL for a distribution - this could be ftp, http or https */
+export declare const distUrlArb: ({ schemeArb, hostArb }?: UrlArbOptions) => jsc.Arbitrary<string>;
+
+/**
+ * Fuzzes a string, changing the case and putting random strings around it
+ * and in spaces.
+ */
+export declare function fuzzStringArb(string: string, fuzzArb?: jsc.Arbitrary<string>): jsc.Arbitrary<string>;
+
+/**
+ * Gets the result of the passed string arbitrary and fuzzes it, changing
+ * the case and putting random strings around it and in spaces.
+ */
+export declare function fuzzStringArbResult(stringArb: jsc.Arbitrary<string>, fuzzArb?: jsc.Arbitrary<string>): MonadicArb<string>;
+
+export declare const lcAlphaNumCharArb: jsc.Arbitrary<string>;
+
+export declare const lcAlphaNumStringArb: jsc.Arbitrary<string>;
+
+export declare const lcAlphaNumStringArbNe: jsc.Arbitrary<string>;
+
+export declare const lcAlphaStringArb: jsc.Arbitrary<string>;
+
+export declare const lcAlphaStringArbNe: jsc.Arbitrary<string>;
+
+export declare const lowerCaseAlphaCharArb: jsc.Arbitrary<string>;
+
+export declare type MonadicArb<T> = jsc.Arbitrary<T> & {
+    flatMap<U>(arbForward: (t: T) => jsc.Arbitrary<U>, backwards: (u: U) => T): MonadicArb<U>;
+};
+
+export declare const numArb: jsc.Arbitrary<string>;
+
+export declare const peopleNameArb: jsc.Arbitrary<string>;
+
+/**
+* A record in the registry, usually including data for one or more aspects, unique for a tenant.
+*/
+declare class Record_2 {
+    /**
+    * The identifier of the record
+    */
+    'id': string;
+    /**
+    * The name of the record
+    */
+    'name': string;
+    /**
+    * The aspects included in this record
+    */
+    'aspects': any;
+    /**
+    * The read authorization policy id of a record
+    */
+    'authnReadPolicyId': string;
+    /**
+    * A tag representing the action by the source of this record (e.g. an id for a individual crawl of a data portal).
+    */
+    'sourceTag': string;
+    /**
+    * The identifier of a tenant
+    */
+    'tenantId': number;
+}
+export { Record_2 as Record }
+
+export declare const recordArb: jsc.Arbitrary<Record_2>;
+
+/**
+ * Generates records, allowing specific arbs to be defined for the distribution.
+ */
+export declare const recordArbWithDistArbs: (distStringsOverrides?: DistStringsOverrideArbs, sourceLinkOverrides?: SourceLinkOverrideArbs, datasetFormatOverrides?: DatasetFormatOverrideArbs) => jsc.Arbitrary<Record_2>;
+
+/**
+ * Randomly generates a record with the passed objects under its
+ * distributions' dcat-distribution-strings aspect.
+ */
+export declare const recordArbWithDists: (dists: object[]) => jsc.Arbitrary<Record_2>;
+
+/**
+ * Randomly returns a subset of the array, in-order.
+ */
+export declare function someOf<T>(array: T[]): jsc.Arbitrary<T[]>;
+
+/**
+ * Generates the content of source link status aspect
+ */
+export declare const sourceLinkArb: ({ status }: SourceLinkOverrideArbs) => jsc.Arbitrary<{
+    status: string;
+}>;
+
+/**
+ * Can be passed into sourceLinkArb to override the default arbitraries.
+ */
+export declare type SourceLinkOverrideArbs = {
+    status?: jsc.Arbitrary<string | undefined>;
+};
+
+export declare const specificRecordArb: (aspectArbs: {
+    [key: string]: jsc.Arbitrary<any>;
+}) => jsc.Arbitrary<Record_2>;
+
+/**
+ * Generates a random string with characters greater than code 32 (so no random
+ * TTY crap that can't be matched by any regex
+ */
+export declare const stringArb: jsc.Arbitrary<string>;
+
+declare type UrlArbOptions = {
+    schemeArb?: jsc.Arbitrary<string>;
+    hostArb?: jsc.Arbitrary<string>;
+};
+
+export { }