@liase/core 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright © 2024 Callum Gare
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,62 @@
+# liase (`@liase/core`)
+
+> *Named "liase" — yes, that's a typo of "liaison". The correct spelling has been pointed out. The name has not been corrected. Moving on.*
+
+> :warning: **This package is currently experimental and the API is both poorly documented and likely to change**
+
+liase attempts to provide a consistent API to search for, and pull the metadata of, various types of media (images, video, gifs, etc) from a variety of sites and sources.
+
+## Search
+
+```js
+import { createLiaseQuery } from "@liase/core";
+
+// Self-executing async function is used here simply to enable the use of await.
+(async () => {
+  // Search and return immediately the first page of results
+  const response = await createLiaseQuery({
+    request: {
+      source: "giphy",
+      queryType: "search",
+      searchText: "cheese",
+    },
+    queryOptions: {
+      secrets: {
+        apiKey: process.env.GIPHY_API_KEY,
+      },
+    },
+  }).getNext();
+  // Prints the number of results in the first page
+  console.log(`Got ${response?.media.length} gifs`);
+})();
+
+(async () => {
+  // Alternatively create a query object which can be modified and iterated over
+  const mediaQuery = createLiaseQuery({
+    request: {
+      source: "giphy",
+      queryType: "search",
+      searchText: "cake",
+    },
+    queryOptions: {
+      fetchCountLimit: 3,
+      secrets: {
+        apiKey: process.env.GIPHY_API_KEY,
+      },
+    },
+  });
+
+  const media = [];
+
+  for await (const response of mediaQuery) {
+    media.push(...response.media);
+  }
+
+  console.log(`Got ${media.length} gifs in total`);
+})();
+```
+
+## Other
+
+liase can also be used with the [@liase/cli tool](https://github.com/callumgare/liase/tree/main/packages/cli).
+