feat(schema): remove include type from default schema

BREAKING CHANGE: the include type requires a significant subset of
the synchronous fs API to be provided when creating a schema, even
if the include type is never used. Since the resolution must be
synchronous, the include type is limited to local fs and memory
access, and not very useful with network loading. It has been
removed from the default schema, but can be included by calling
`createIncludeSchema` instead.

docs/api/js-yaml-schema.createinclude.md

@@ -6,6 +6,8 @@
 
 Instantiate an include type with a copy of the provided options, returning the include type and its schema setter.
 
+Includes must be resolved synchronously, which greatly limits where this can be used.
+
 <b>Signature:</b>
 
 ```typescript

docs/api/js-yaml-schema.createschema.md

@@ -4,19 +4,18 @@
 
 ## createSchema() function
 
-Safe schema with additional library types added.
 
 <b>Signature:</b>
 
 ```typescript
-export declare function createSchema(options: Readonly<SchemaOptions>): Schema;
+export declare function createSchema(options: SchemaOptions): Schema;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | Readonly&lt;[SchemaOptions](./js-yaml-schema.schemaoptions.md)<!-- -->&gt; |  |
+|  options | [SchemaOptions](./js-yaml-schema.schemaoptions.md) |  |
 
 <b>Returns:</b>
 

docs/api/js-yaml-schema.includeoptions.md

@@ -4,6 +4,8 @@
 
 ## IncludeOptions interface
 
+Additional options for the include type.
+
 <b>Signature:</b>
 
 ```typescript

docs/api/js-yaml-schema.md

@@ -8,14 +8,14 @@
 
 |  Function | Description |
 |  --- | --- |
-|  [createInclude(options)](./js-yaml-schema.createinclude.md) | Instantiate an include type with a copy of the provided options, returning the include type and its schema setter. |
-|  [createSchema(options)](./js-yaml-schema.createschema.md) | Safe schema with additional library types added. |
+|  [createInclude(options)](./js-yaml-schema.createinclude.md) | Instantiate an include type with a copy of the provided options, returning the include type and its schema setter.<!-- -->Includes must be resolved synchronously, which greatly limits where this can be used. |
+|  [createSchema(options)](./js-yaml-schema.createschema.md) |  |
 
 ## Interfaces
 
 |  Interface | Description |
 |  --- | --- |
-|  [IncludeOptions](./js-yaml-schema.includeoptions.md) |  |
+|  [IncludeOptions](./js-yaml-schema.includeoptions.md) | Additional options for the include type. |
 |  [SchemaOptions](./js-yaml-schema.schemaoptions.md) |  |
 
 ## Variables

docs/api/js-yaml-schema.schemaoptions.include.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@apextoaster/js-yaml-schema](./js-yaml-schema.md) &gt; [SchemaOptions](./js-yaml-schema.schemaoptions.md) &gt; [include](./js-yaml-schema.schemaoptions.include.md)
-
-## SchemaOptions.include property
-
-<b>Signature:</b>
-
-```typescript
-include: Readonly<Omit<IncludeOptions, 'schema'>>;
-```

docs/api/js-yaml-schema.schemaoptions.md

@@ -4,6 +4,7 @@
 
 ## SchemaOptions interface
 
+
 <b>Signature:</b>
 
 ```typescript
@@ -15,5 +16,4 @@ export interface SchemaOptions
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [base?](./js-yaml-schema.schemaoptions.base.md) | Schema | <i>(Optional)</i> |
-|  [include](./js-yaml-schema.schemaoptions.include.md) | Readonly&lt;Omit&lt;[IncludeOptions](./js-yaml-schema.includeoptions.md)<!-- -->, 'schema'&gt;&gt; |  |
 

src/schema.ts

@@ -6,17 +6,43 @@ import { createInclude, IncludeOptions } from './type/Include';
 import { regexpType } from './type/Regexp';
 import { streamType } from './type/Stream';
 
+/**
+ * @public
+ */
 export interface SchemaOptions {
   base?: Schema;
+}
+
+/**
+ * @public
+ */
+export function createSchema(options: SchemaOptions) {
+  const base = mustCoalesce(options.base, DEFAULT_SCHEMA);
+
+  return base.extend([
+    envType,
+    regexpType,
+    streamType,
+  ]);
+}
+
+/**
+ * @public
+ * @deprecated
+ */
+export interface IncludeSchemaOptions {
+  base?: Schema;
   include: Readonly<Omit<IncludeOptions, 'schema'>>;
 }
 
 /**
- * Safe schema with additional library types added.
+ * Extended schema with the include type, and auto-configuration
+ * of the include schema.
  *
  * @public
+ * @deprecated use createSchema unless the include type is needed, since it requires a number of callbacks
  */
-export function createSchema(options: Readonly<SchemaOptions>) {
+export function createIncludeSchema(options: Readonly<IncludeSchemaOptions>) {
   const base = mustCoalesce(options.base, DEFAULT_SCHEMA);
   const {includeType, setSchema} = createInclude({
     ...options.include,

src/type/Include.ts

@@ -9,6 +9,10 @@ export interface ReaderOptions {
 
 export type IncludeReader = (path: string, options: ReaderOptions) => string;
 
+/**
+ * Additional options for the include type.
+ * @public
+ */
 export interface IncludeOptions {
   exists: (path: string) => boolean;
   join: (...path: Array<string>) => string;
@@ -21,6 +25,8 @@ export interface IncludeOptions {
  * Instantiate an include type with a copy of the provided options,
  * returning the include type and its schema setter.
  *
+ * Includes must be resolved synchronously, which greatly limits where this can be used.
+ *
  * @public
  */
 export function createInclude(options: Readonly<IncludeOptions>) {